Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
Promotion code.
"PROMO123"
If a customer_id
is set, this promotion code will only be available to this customer.
"cus_DKL4Xcb5VSa8CQ"
If a plan_id
is set, this promotion code will only be available for subscriptions with this plan ID.
"plan_DKL4Xcb5VSa8CQ"
If a product_id
is set, this promotion code will only be available for subscriptions with this product ID.
"itm_DKL4Xcb5VSa8CQ"
Date and time when the promotion code expires.
"2021-01-01T00:00:00.000Z"
Maximum number of redemptions for the promotion code. Independent from coupon's max redemptions.
10
Current number of redemptions for the promotion code.
0
Duration count applied to the subscription for the promotion code. 0 or null for once
x >= 1
1
Duration period applied to the subscription for the promotion code for the promotion code. Valid values are once
, days
, weeks
, months
, years
once
, days
, weeks
, months
, years
"months"
Whether the promotion code is only for first time orders. Defaults to false
false
Response
Promotion code ID.
"promo_DKL4Xcb5VSa8CQ"
Promotion code.
"PROMO123"
Coupon ID.
"cou_DKL4Xcb5VSa8CQ"
Client ID.
"cli_DKL4Xcb5VSa8CQ"
If a customer_id
is set, this promotion code will only be available to this customer.
"cus_DKL4Xcb5VSa8CQ"
If a plan_id
is set, this promotion code will only be available for subscriptions with this plan ID.
"plan_DKL4Xcb5VSa8CQ"
If a product_id
is set, this promotion code will only be available for subscriptions with this product ID.
"itm_DKL4Xcb5VSa8CQ"
Date and time when the promotion code expires.
"2021-01-01T00:00:00.000Z"
Maximum number of redemptions for the promotion code. Independent from coupon's max redemptions.
10
Current number of redemptions for the promotion code.
0
Duration count applied to the subscription for the promotion code. 0 or null for once
1
Duration period applied to the subscription for the promotion code for the promotion code. Valid values are once
, days
, weeks
, months
, years
once
, days
, weeks
, months
, years
"months"
Whether the promotion code is only for first time orders. Defaults to false
false