post https://api.revolv3.com/api/Checkout
Create a checkout for a merchant with a Checkout Subscription ID and optional customer ID and customer email address.
Upon success, a status code of 201 (Created) will be returned.
If a checkout cannot be created with the provided data, a status code of 400 (Bad Request) will be returned.
Name | Description |
---|---|
CheckoutSubscription | Information for creating a checkout subscription |
BillingFrequencyType | How often the subscription should be attempted for billing |
SubscriptionBillingPlans | The subscription's individual billing items |
BillingPlanName | The subscription's primary payment information |
BillingPlanValue | Value for which the billing plan should be executed for |
Name | Description | Default value |
---|---|---|
CustomerId | Customer's unique identifier | null |
MerchantCustomerRefId | Merchant's identifier for the customer | null |
MerchantSubscriptionRefId | Merchant's unique identifier for the subscription | null |
SubscriptionCancelType | The circumstances under which a subscription must be cancelled (e.g. Immediate or EndOfCycle) | |
TrialDuration | The amount of trial duration time in the unit of TrialDurationType | 0 |
TrialDurationType | The type of trial duration | Daily |
BillingPlanCycleCount | The number of times the billing plan should be billed before expiration | -1 |
BillingPlanValueType | A qualifier for how the value should be interpreted (e.g. standard, discount, discountPercentage, finalDiscount, or priceOverride) | Standard |
BillingPlanStartCycleDelay | Amount of subscription cycle to delay the start date of the billing plan | 0 |
TaxCode | The billing plan's AvaTax TaxCode | null |