Billing: CRUD Coupons

The following endpoints can be used to maintain and use coupons.

 

Create coupons

All coupons should be created on Stripe; they will automatically be synced with the portal.

 

Retrieve a coupon

You can use the following endpoint within your custom pages in order to get information about a specific coupon. The coupon should be set up through Stripe before using this endpoint.

Summary

  • Endpoint: /api/v2/billing_check_coupon
  • Method: GET
  • Required User Type: TA

Response

A successful response will return an object with coupon information.

An empty response will return if the coupon doesn't exist. 

Example

Request

/api/v2/billing_check_coupon?coupon_id=testcoupon 

Response Data

{
"object": "coupon",
"name": "Test Coupon",
"percent_off": 50,
"livemode": false,
"valid": true,
"duration": "forever",
"id": "testcoupon",
...
}

 

Update Coupon

All coupons should be update on Stripe; they will automatically be synced with the portal.

 

Delete Coupon

All coupons should be deleted/archived on Stripe; this will automatically be synced with the portal.