recurring-subscription

authorized-by-shopper

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

auto-renew

boolean

Optional

Optional Update Subscription requests only

Determines whether the subscription automatically continues, or expires at the end of the current period.

descriptor-phone-number

string

Optional

Merchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters.

initial-tax-reference

string

Optional

ID of the tax quote for the initial subscription charge. For details, see Taxes guide.

level-3-data

container

Optional

Container of level-3-data properties.

next-charge-date

string

Optional

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

override-initial-charge-amount

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, any later changes to the plan's price are not applied to this subscription.

override-recurring-charge-amount

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.

override-trial-period-days

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 trial-period-days is used.

payer-info

container

Optional

Do not include if sending vaulted-shopper-id

Container of payer-info properties.

payment-source

container

Requiredfor Create Subscription if sendingpayer-info

Optional if sending vaulted-shopper-id

Container of payment-source properties.

plan-id

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).

recurring-tax-reference

string

Optional

ID of the tax quote for recurring subscription charges. For details, see Taxes guide.

soft-descriptor

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

three-d-secure

container

Optional

Container of three-d-secure properties.

transaction-fraud-info

container

Required for Create Subscription

Container of transaction-fraud-info properties.

transaction-order-source

string

Optional

Identifies the order type. The only option is MOTO  (Mail Order Telephone Order). Any other option is ignored.

vaulted-shopper-id

integer

Optional

Do not include if sending payer-info

ID of an existing vaulted shopper.

auto-renew

boolean

Determines whether the subscription automatically continues, or expires at the end of the current period.

charge-frequency

string

Possible values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
EVERY 3 YEARS

charge

container

Create Subscription response only

Container of charge properties.

currency

string

Currency code (ISO 4217) of the amount to be charged. Refer to Currency codes.

descriptor-phone-number

string

Description of the transaction, which appears on the shopper's credit card statement.

fraud-result-info

container

Create Subscription response only

Container of fraud-result-info properties.

initial-charge-amount

decimal

Amount of the initial charge.
For example: 99.00

level-3-data

container

Container of level-3-data properties.

next-charge-date

string

Appears only if subscription is ACTIVE_
Next charge date.
Format: yyyy-mm-dd

override-initial-charge-amount

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.

override-recurring-charge-amount

decimal

Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.

override-trial-period-days

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.

payer-info

container

Container of payer-info properties.

payment-source

container

Container of payment-source properties.

plan-id

integer

ID of the billing plan associated with this subscription.

quantity

integer

Quantity to apply to the subscription.
Default is 1.

recurring-charge-amount

decimal

Recurring amount to be charged.
For example: 29.99

recurring-tax-reference

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)

soft-descriptor

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)

subscription-id

integer

BlueSnap identifier for the subscription.

three-d-secure

container

Container of three-d-secure properties.

trial-period-days

integer

Number of days in the trial period.
For example: 14

vaulted-shopper-id

integer

ID of an existing vaulted shopper.