recurring-subscription

Contains information about a specific subscription

Request

Property NameTypeRequiredDescription
plan-idintegerRequired for Create SubscriptionID of the billing plan associated with this subscription.
vaulted-shopper-idintegerOptional
Do not include if sending payer-info
ID of an existing vaulted shopper.
payer-infocontainerOptional
Do not include if sending vaulted-shopper-id
Container of payer-info properties.
payment-sourcecontainerRequired for Create Subscription if sending payer-info

Optional if sending vaulted-shopper-id
Container of payment-source properties.
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).
soft-descriptorstringOptionalDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
descriptor-phone-numberstringOptionalMerchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters.
override-trial-period-daysintegerOptionalNumber 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 trial-period-days is used.
override-recurring-charge-amountdecimalOptionalRecurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.
override-initial-charge-amountdecimalOptionalInitial 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.
transaction-fraud-infocontainerRequired for Create SubscriptionContainer of transaction-fraud-info properties.
auto-renewbooleanOptional
Optional Update Subscription requests only
Determines whether the subscription automatically continues, or expires at the end of the current period.
authorized-by-shopperbooleanRequired 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.
next-charge-datestringOptional
Create/Update Subscription requests only
Next charge date.
If you change this, the date of future recurring charges is adjusted accordingly.

Format: yyyy-mm-dd
statusstringOptional
Create/Update Subscription requests only
Permitted values:
ACTIVE
CANCELED
level-3-datacontainerOptionalContainer of level-3-data properties.
three-d-securecontainerOptionalContainer of three-d-secure properties.
transaction-order-sourcestringOptionalIdentifies the order type.
The only option is MOTO  (Mail Order Telephone Order).
Any other option is ignored.
initial-tax-referencestringOptionalID of the tax quote for the initial subscription charge. For details, see Taxes guide.
recurring-tax-referencestringOptionalID of the tax quote for recurring subscription charges. For details, see Taxes guide.

Response

Property NameTypeRequired
subscription-idintegerBlueSnap identifier for the subscription.
plan-idintegerID of the billing plan associated with this subscription.
vaulted-shopper-idintegerID 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.
soft-descriptorstringDescription of the transaction, which appears on the shopper's credit card statement.
descriptor-phone-numberstringDescription of the transaction, which appears on the shopper's credit card statement.
charge-frequencystringPossible values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
EVERY 3 YEARS
trial-period-daysintegerNumber of days in the trial period.
For example: 14
override-trial-period-daysintegerNumber of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription.
recurring-charge-amountdecimalRecurring amount to be charged.
For example: 29.99
override-recurring-charge-amountdecimalRecurring 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.
initial-charge-amountdecimalAmount of the initial charge.
For example: 99.00
override-initial-charge-amountdecimalInitial 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.
auto-renewbooleanDetermines whether the subscription automatically continues, or expires at the end of the current period.
next-charge-datestringAppears only if subscription is ACTIVE
Next charge date.
Format: yyyy-mm-dd
payer-infocontainerContainer of payer-info properties.
payment-sourcecontainerContainer of payment-source properties.
chargecontainerCreate Subscription response only

Container of charge properties.
fraud-result-infocontainerCreate Subscription response only

Container of fraud-result-info properties.
level-3-datacontainerContainer of level-3-data properties.
three-d-securecontainerContainer of three-d-secure properties.
scheduledbooleanIdentifies if the transaction is a regularly scheduled event.

Possible values:
true
false (default)

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