Create a subscription for a customer (specified by Customer ID) with a Billing Frequency Type (Daily, Weekly, Biweekly, Monthly, Bimonthly, Quarterly, Semiannually, Yearly), subscription Billing Plans items, the payment method information (with billing address, billing first name, billing last name, payment method type (credit card, ach, google pay)) or an authorized payment method identifier or payment method identifier must be provided.
Optionally, a Merchant Subscription Ref ID, Tax Address, Start Date, Trial Duration, Trial Duration Type (the same values as in Billing Frequency Type), Subscription Status Type (Current, Recycle) and Subscription Cancel Type (Immediate, EndOfCycle) may be included.
Upon successful creation of the subscription, a status code of 201 (Created) will be returned.
If the provided Customer ID does not exist, a status code of 404 (Not Found) will be returned.
If a subscription cannot be created with the provided data, a status code of 400 (Bad Request) will be returned.
| Name | Description |
|---|---|
| BillingFrequencyType | How often the subscription should be attempted for billing |
| SubscriptionBillingPlans | The subscription's individual billing items |
| Name | Description | Default value |
|---|---|---|
| MerchantSubscriptionRefId | Merchant's unique identifier for the subscription | null |
| SubscriptionStatusType | The subscription's current standing (e.g. Current, Recycle, Cancelled, PendingCancellation) | Current |
| SubscriptionCancelType | The circumstances under which a subscription must be cancelled (e.g. Immediate or EndOfCycle) | EndOfCycle |
| StartDate | Subscription's start date | Today |
| TrialDuration | The amount of trial duration time in the unit of TrialDurationType | 0 |
| TrialDurationType | The type of trial duration | Daily |
| TaxAddress | Address to be used for taxation purposes. Possible sets of Address details: AddressLine1, City and State or AddressLine1 and PostalCode or State and PostalCode | null |
| PaymentMethodAuthorizationId | Unique identifier for a previously pre-authorized payment method | null |
| PaymentMethod | The primary payment information | null |
| PaymentMethodId | Unique identifier for the customer's payment information | null |