Create Subscription
Creates a new subscription in Raisely.
Query
Comma-separated response fields to include.
Body
True if the person's name should be hidden from donation feeds Examples: `true`, `false`
The gateway card ID to charge when collecting the subscription Example: `card_aabbccddeeffaabbccddeeff`
The frequency of the subscription, used in conjunction with the `interval` property. For instance, a monthly subscription would have a `count` of `1` and an `interval` of `MONTH`. A fortnightly subscription would have a `count` of `2` and an `interval` of `WEEK`. Examples: `1`, `4`
ISO alpha-3 letter currency code Examples: `AUD`, `USD`
The gateway customer ID (only used when importing new subscriptions) Example: `cus_xxxxxxxxxxxxxx`
The user's email address. Raisely uses this as a unique identifier and will associate the subscription with an existing record if the email matches. Example: `[email protected]`
The first name of the person Example: `Leila`
The full name of the person Example: `Leila Norma Eulalia Josefa Magistrado de Lima`
The interval of the subscriptions. See `count`. Examples: `WEEK`, `MONTH`, `YEAR`
`public` The amount spent on the item in the currency of the donation
`public` The total amount refunded in cents for this line item, in the donation currency.
`public` Whether the donation item (ticket) has been checked in
`public` The amount spent on the item in the currency of the campaign
`public` ISO8601 created timestamp
`public` Description of the item
`public` If false, the amount is not included in receipts as part of the total donation
`public` The item ID / reference
`public` The total amount of this line item in cents prior to any refunds, in the donation currency. Amount is tax inclusive.
`public` The item ID / reference of this ticket's parent bundle
`public` The ticket's parent bundle description
`public` Deprecated
`public` The uuid for the associated product or ticket.
`public` If multiple of the item, the number of items claimed
`public` The status of the donation item
`public` The item type. For most manual API calls, you should use the value `OTHER`.
`public` ISO8601 created timestamp
`public` Unique identifier for the item
The last name of the person Example: `de Lima`
A public message left by the donor Example: `Glad to help out with the fundraising!`
The payment gateway used for the subscription. Use STRIPE_INTENT for new subscriptions. Examples: `STRIPE_INTENT`, `CREDIT_CARD`, `CUSTOM`, `PAYPAL`
The type of payment method used, to distinguish between card, direct debit and digital wallet payments. Examples: `CARD`, `APPLE_PAY`, `GOOGLE_PAY`, `BROWSER_PAY`, `DD_BACS`, `DD_BECS`
An ISO8601 timestamp of the next payment due date. Raisely will charge the donation after this date. Example: `2020-12-03T06:52:46.330Z`
Stores the preferred day for the subscription to be billed on. If interval is WEEK, it's day of the week. If interval is MONTH, it's the day of the month. If interval is YEAR, it's day of the year. Example: `12345`
The name that the person prefers to be called Example: `Norma`
Private values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
Public values for this record Example: `{ "fieldA": "one", "fieldB": "yes" }`
The source of this subscription. Subscriptions created through the API should have a source of `OFFLINE`. Examples: `OFFLINE`, `ONLINE`
Payment gateway token. Set to `null` when adding offline subscriptions with `card` and `customer`. Examples: `seti_xxxxxxxxxxxxxxxxxx`, `EXISTING_CARD`
This field is only for importing new subscriptions. When false (default), the first successful charge of the card will result in a subscription.rebilled event. Set to true to change the first event to subscription.succeeded and send the Regular Donation Welcome message on the first payment after import. Examples: `true`, `false`