subscription

Request

Property Name	Type	Required	Description
`authorizedByShopper`	boolean	Required for SEPA Direct Debit Create Subscription requests only	Value must be true. Pass this parameter to indicate that you have obtained the shopper's authorization of the SEPA Direct Debit mandate.
`autoRenew`	boolean	Optional Optional Update Subscription requests only	Determines whether the subscription automatically continues, or expires at the end of the current period.
`descriptorPhoneNumber`	string	Optional	Merchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters.
`initialTaxReference`	string	Optional	ID of the tax quote for the initial subscription charge. For details, see Taxes guide.
`level3Data`	container	Optional	Refer to level3Data.
`nextChargeDate`	string	Optional Create/Update Subscription requests only	Next charge date. If you change this, the date of future recurring charges are adjusted accordingly. Format: yyyy-mm-dd
`overrideInitialChargeAmount`	decimal	Optional	Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. If you override the price by this property in the request, then any later changes to the plan's price are not applied to this subscription.
`overrideRecurringChargeAmount`	decimal	Optional	Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.
`overrideTrialPeriodDays`	integer	Optional	Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription. Note: This value must be greater than `0`. If the value is set to `0`, the property is ignored and the `trialPeriodDays` is used.
`payerInfo`	container	Optional Do not include if sending `vaultedShopperId`	Refer to payerInfo.
`paymentSource`	container	Required for Create Subscription if sending `payerInfo` Optional if sending `vaultedShopperId`	Refer to paymentSource.
`planId`	integer	Required for Create Subscription	ID of the billing plan associated with this subscription.
`quantity`	integer	Optional Create Subscription requests only	Quantity to apply to the subscription. Default is 1. For example, to charge for 10 users in this subscription, set the quantity to 10. If the associated plan's price is $30 per month, then this subscription's recurring payment will be $300 per month (10 x $30).
`recurringTaxReference`	string	Optional	ID of the tax quote for recurring subscription charges. For details, see Taxes guide.
`softDescriptor`	string	Optional	Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
`status`	string	Optional Create/Update Subscription requests only	Permitted values: ACTIVE CANCELED
`threeDSecure`	container	Optional	Refer to threeDSecure.
`transactionFraudInfo`	container	Required for Create Subscription	Refer to transactionFraudInfo.
`transactionOrderSource`	string	Optional	Refer to cardTransaction
`vaultedShopperId`	integer	Optional Do not include if sending `payerInfo`	ID of an existing vaulted shopper.

Response

Property Name	Type	Required
`autoRenew`	boolean	Determines whether the subscription automatically continues, or expires at the end of the current period.
`charge`	container	Create Subscription response only Refer to charge.
`chargeFrequency`	string	Possible values: `ONCE` `DAILY` `WEEKLY` `EVERY 2 WEEKS` `MONTHLY` `EVERY 2 MONTHS` `QUARTERLY` `EVERY 6 MONTHS` `ANNUALLY` `EVERY 2 YEARS` `EVERY 3 YEARS`
`currency`	string	Currency code (ISO 4217) of the amount to be charged. Refer to Currency codes.
`descriptorPhoneNumber`	string	Merchant's support phone number that appears on the shopper's bank statement.
`fraudResultInfo`	container	Create Subscription response only Refer to fraudResultInfo.
`initialChargeAmount`	decimal	Amount of the initial charge. For example: `99.00`
`level3Data`	container	Refer to level3Data.
`nextChargeDate`	string	Appears only if subscription is ACTIVE Next charge date. Format: yyyy-mm-dd
`overrideInitialChargeAmount`	decimal	Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription. If you override the price, any later changes to the plan's price are not applied to this subscription.
`overrideRecurringChargeAmount`	decimal	Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.
`overrideTrialPeriodDays`	integer	Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription.
`payerInfo`	container	Refer to payerInfo.
`paymentSource`	container	Refer to paymentSource.
`planId`	integer	ID of the billing plan associated with this subscription.
`quantity`	integer	Quantity to apply to the subscription. Default is `1`.
`recurringChargeAmount`	decimal	Recurring amount to be charged. For example: `29.99`
`recurringTaxReference`	string	ID of the tax quote for recurring subscription charges. For details, see Taxes guide.
`scheduled`	boolean	Identifies if the transaction is a regularly scheduled event. Possible values: `TRUE` `FALSE` (default) Refer to Card on File Guide.
`softDescriptor`	string	Description of the transaction, which appears on the shopper's credit card statement.
`status`	string	Possible values: `ACTIVE` `CANCELED` `ON_HOLD` (the subscription is outside its grace-period) `SUSPENDED` `FINISHED` (the subscription reached the plan's `max-number-of-charges` limit)
`subscriptionId`	integer	BlueSnap identifier for the subscription.
`threeDSecure`	container	Refer to threeDSecure.
`trialPeriodDays`	integer	Number of days in the trial period. For example: `14`
`vaultedShopperId`	integer	ID of an existing vaulted shopper.