Plan: Create
- Python
result = gateway.plan.create({
"name": "the_name",
"billing_frequency": "the_billing_frequency",
"currency_iso_code": "the_currency_iso_code",
"price": "the_price"
});
Parameters
The collection of add-ons associated with a plan. Add-on details can only be managed within the Control Panel.
'add'
arrayArray of add-ons to add to the plan.
'amount'
DecimalPrice of the add-on. This will override the inherited add-on amount.
A description of the add-on.
Specify an add-on ID to apply to the pan. You can't duplicate an add-on for a plan, but you can update the quantity.
'name'
strThe name of the add-on.
Number of billing cycles to apply the add-on. It must be greater than 0.
'remove'
arrayArray of add-on IDs that are associated with the subscription. IDs specified will be removed from the plan.
'update'
arrayArray of add-ons that are associated with the plan.
'amount'
DecimalPrice of the add-on. This will override the inherited add-on amount.
A description of the add-on.
Update a particular add-on by specifying the add-on ID.
'name'
strThe name of the add-on.
Number of billing cycles to apply the add-on. It must be greater than 0.
'billing_day_of_month'
integer or stringThe value that specifies the day of the month that the gateway will charge the subscription on every billing cycle.
'billing_frequency'
integer or stringSpecifies the billing interval of the plan.
The currency for the transaction. The three-letter alphabetic codes for the transaction's currency (e.g. "USD" for US dollars).
A description of the plan.
A collection of discounts associated with this plan. Discount details can only be managed within the Control Panel.
'add'
arrayArray of discounts to add to the plan.
'amount'
DecimalPrice of the discount. This will override the inherited discount amount.
A description of the discount.
Specify a discount ID to apply to the plan. You can't duplicate an discount for a plan, but you can update the quantity.
'name'
strThe name of the discount.
Number of billing cycles to apply the discount. It must be greater than 0.
'remove'
arrayArray of discount IDs that are associated with the subscription. IDs specified will be removed from the plan.
'update'
arrayArray of discounts that are associated with the plan.
'amount'
DecimalPrice of the discount. This will override the inherited discount amount.
A description of the discount.
Update a particular discount by specifying the discount ID.
'name'
strThe name of the discount.
Number of billing cycles to apply the discount. It must be greater than 0.
'id'
strA string value representing a specific plan. Max 36 characters; must be unique within a merchant's Vault; valid characters are letters, numbers, - and _. If not specified on creation, the gateway will generate an alphanumeric ID that can be accessed on the result. The generated IDs will never start with a leading 0 and are case-insensitive.
The collection of Modification Tokens associated with a plan. A modification is an add_on or a discont. So modification tokens can be passed to assiciate with a plan when creating the plan.
'name'
strThe name of the plan.
'never_expires'
boolean or stringWhether a subscription's billing cycle is set to never expire, or to run for a specific number of billing cycles.
'number_of_billing_cycles'
integer or stringSpecifies the number of billing cycles of the plan.
'price'
decimal or stringThe base price specified for a plan, formatted like "10" or "10.00".
The trial timeframe specified in a plan. It is required if the trial period is set to True and must be 1-3 digits. If you specify a trial duration of 0, the gateway will start the subscription immediately and not consider it to include a trial period.
The trial unit specified in a plan. Specify
day
or month
.'trial_period'
boolA value indicating whether a subscription should begin with a trial period. If not specified on creation, the gateway will generate False by default. It cannot have both a specified billing date and a trial period.
Add add_ons/discounts when creating a plan
There are two ways to add add_ons/discounts when creating a plan. First, modification tokens can be
passed along when creating a plan. A modification is either an add_on or a discount.
- Python
result = gateway.plan.create({
"name": "the_name",
"billing_frequency": "the_billing_frequency",
"currency_iso_code": "the_currency_iso_code",
"price": "the_price",
"modification_tokens": [
"modification1_token",
"modification2_token"
]
});
- Add-ons/discounts that would be inherited from the plan can be updated on the plan.
- Add-ons/discounts that would be inherited from the plan can be removed from the plan.
- Python
result = gateway.plan.create({
"name": "the_name",
"billing_frequency": "the_billing_frequency",
"currency_iso_code": "the_currency_iso_code",
"price": "the_price",
"add_ons": {
"add": [
{
"inherited_from_id": "add_on_id_1",
"amount": Decimal("20.00")
},
{
"inherited_from_id": "add_on_id_2",
"amount": Decimal("30.00")
}
],
"update": [
{
"existing_id": "add_on_id_3",
"description": "Updated description"
},
{
"existing_id": "add_on_id_4",
"description": "Updated description"
}
],
"remove": [
"add_on_id_5",
"add_on_id_6"
]
},
"discounts": {
"add": [
{
"inherited_from_id": "discount_id_1",
"amount": Decimal("7.00")
}
],
"update": [
{
"existing_id": "discount_id_2",
"amount": Decimal("15.00")
}
],
"remove": [
"discount_id_3"
]
}
});
- amount
- number_of_billing_cycles
- name
- description
- Python
result = gateway.plan.create({
"name": "the_name",
"billing_frequency": "the_billing_frequency",
"currency_iso_code": "the_currency_iso_code",
"price": "the_price",
"add_ons": {
"add": [
{
"inherited_from_id": "add_on_id_1",
"amount": Decimal("20.00"),
"number_of_billing_cycles": 2,
"name": "NewName",
"description": "NewDescription"
}
],
"update": [
{
"existing_id": "add_on_id_2",
"amount": Decimal("15.00"),
"number_of_billing_cycles": 2,
"name": "NewName",
"description": "NewDescription"
}
]
},
"discounts": {
"add": [
{
"inherited_from_id": "discount_id_1",
"amount": Decimal("20.00"),
"number_of_billing_cycles": 2,
"name": "NewName",
"description": "NewDescription"
}
],
"update": [
{
"existing_id": "discount_id_2",
"amount": Decimal("15.00"),
"never_expires": True,
"quantity": 3,
"number_of_billing_cycles": 2,
"name": "NewName",
"description": "NewDescription"
}
]
}
});