Subscription

id uuidrequired

Cents id of the transaction

company_id uuidrequired

Cents id of the company

subscription_type stringrequired

Possible values: [monthly, round_up, saving_account]

The type of the subscription

recurring_donation_amount integerrequired

Donation amount (in the smallest currency unit, so 1000 is 10.00€).

round_up_source_id uuidrequired

Id of the round up source to be used to calculate round amount.

recurring_donation_percentage integerrequired

Donation percentage if available (in integer format, so 3% is 3).

billing_day integerrequired

Default value: today

Day of the month when perform the billing.

next_billing_date date

Date of the next billing.

payment_method_id uuidrequired

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

donation_currency stringrequired

Donation currency

charity_id uuidrequired

Cents id of the charity

donation_cause stringrequired

Cause unique name (in the namespace of the charity)

created_date daterequired

Subscription created date

updated_date daterequired

Subscription updated date

consumer_user_id stringrequired

Cents id of consumer user (if we have data of it)

consumer_user_full_name stringrequired

Consumer user full name (if we have data of it)

consumer_user_email emailrequired

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 stringrequired

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

billable_address

object

required

street_address stringrequired

city stringrequired

region_state stringrequired

zip_code stringrequired

country stringrequired
subscription_status stringrequired

Possible values: [pre_subscription, draft, active, inactive, failed]

Subscription status

reconciliation_id stringrequired

External ID (generated by the company) used to reconcilate transaction with the pre_transaction