subscription

Contains information about a specific subscription

Request

Property NameTypeRequiredDescription
planIdintegerRequired for Create SubscriptionID of the billing plan associated with this subscription.
vaultedShopperIdintegerOptional
Do not include if sending payerInfo
ID of an existing vaulted shopper.
payerInfocontainerOptional
Do not include if sending vaultedShopperId
Refer to payerInfo.
paymentSourcecontainerRequired for Create Subscription if sending payerInfo

Optional if sending vaultedShopperId
Refer to paymentSource.
quantityintegerOptional
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).
softDescriptorstringOptionalDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
descriptorPhoneNumberstringOptionalMerchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters.
overrideTrialPeriodDaysintegerOptionalNumber 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.
overrideRecurringChargeAmountdecimalOptionalRecurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.
overrideInitialChargeAmountdecimalOptionalInitial 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.
transactionFraudInfocontainerRequired for Create SubscriptionRefer to transactionFraudInfo.
autoRenewbooleanOptional
Optional Update Subscription requests only
Determines whether the subscription automatically continues, or expires at the end of the current period.
authorizedByShopperbooleanRequired 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.
nextChargeDatestringOptional
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
statusstringOptional
Create/Update Subscription requests only
Permitted values:
ACTIVE
CANCELED
level3DatacontainerOptionalRefer to level3Data.
threeDSecurecontainerOptionalRefer to threeDSecure.
transactionOrderSourcestringOptionalRefer to cardTransaction
initialTaxReferencestringOptionalID of the tax quote for the initial subscription charge. For details, see Taxes guide.
recurringTaxReferencestringOptionalID of the tax quote for recurring subscription charges. For details, see Taxes guide.

Response

Property NameTypeRequired
subscriptionIdintegerBlueSnap identifier for the subscription.
planIdintegerID of the billing plan associated with this subscription.
vaultedShopperIdintegerID of an existing vaulted shopper.
statusstringPossible 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)
quantityintegerQuantity to apply to the subscription.
Default is 1.
softDescriptorstringDescription of the transaction, which appears on the shopper's credit card statement.
descriptorPhoneNumberstringMerchant's support phone number that appears on the shopper's bank statement.
chargeFrequencystringPossible values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
EVERY 3 YEARS
trialPeriodDaysintegerNumber of days in the trial period.
For example: 14
overrideTrialPeriodDaysintegerNumber of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription.
recurringChargeAmountdecimalRecurring amount to be charged.
For example: 29.99
overrideRecurringChargeAmountdecimalRecurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.
currencystringCurrency code (ISO 4217) of the amount to be charged. Refer to Currency codes.
initialChargeAmountdecimalAmount of the initial charge.
For example: 99.00
overrideInitialChargeAmountdecimalInitial 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.
autoRenewbooleanDetermines whether the subscription automatically continues, or expires at the end of the current period.
nextChargeDatestringAppears only if subscription is ACTIVE
Next charge date.
Format: yyyy-mm-dd
payerInfocontainerRefer to payerInfo.
paymentSourcecontainerRefer to paymentSource.
chargecontainerCreate Subscription response only

Refer to charge.
fraudResultInfocontainerCreate Subscription response only

Refer to fraudResultInfo.
level3DatacontainerRefer to level3Data.
threeDSecurecontainerRefer to threeDSecure.
scheduledbooleanIdentifies if the transaction is a regularly scheduled event.

Possible values:
TRUE
FALSE (default)

Refer to Card on File Guide.
recurringTaxReferencestringID of the tax quote for recurring subscription charges. For details, see Taxes guide.