Skip to main content

PreSubscriptionInput

    subscription_type stringrequired

    Possible values: [monthly, round_up, saving_account]

    The type of the subscription to be created

    recurring_donation_amount integer

    Donation amount (in the smallest currency unit, so 1000 is 10.00€). This field is mandatory if the subscription_type = monthly

    round_up_source_id uuid

    Id of the round up source to be used to calculate round amount. This field is mandatory if the subscription_type = round_up

    recurring_donation_percentage integer

    Donation percentage if available (in integer format, so 3% is 3). This field is mandatory if the subscription_type = saving_account

    billing_day integer

    Default value: today

    Day of the month when perform the billing.

    payment_method_id uuid

    Id of the payment method to be used to pay the donation.

    donation_currency string

    Default value: EUR

    Donation currency

    charity_id uuidrequired

    Cents id of the charity

    donation_cause stringrequired

    Cause unique name (in the namespace of the charity)

    consumer_user_full_name string

    Consumer user name (if we have data of it)

    consumer_user_email email

    Consumer user email (if we have data of it)

    consumer_user_email_anonymized boolean

    Consumer user email anonymized flag (if email is anonymized or not)

    consumer_user_phone string

    Consumer user phone number (if we have data of it)

    billable_address

    object

    street_address stringrequired
    city stringrequired
    region_state stringrequired
    zip_code stringrequired
    country stringrequired
    reconciliation_id string

    External ID (generated by the company) used to reconcilate subscription with the pre-subscription