Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

get/v1/customers/{customer}/discount

Path parameters

customerstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

checkout_sessionstring nullable

The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.

customer_accountstring nullable

The ID of the account representing the customer associated with this discount.

endinteger nullable

If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.

idstring required

The ID of the discount object. Discounts can't be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.

invoicestring nullable

The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

invoice_itemstring nullable

The invoice item id (or invoice line item id for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

object'discount' required

String representing the object's type. Objects of the same type share the same value.

startinteger required

Date that the coupon was applied.

subscriptionstring nullable

The subscription that this coupon is applied to, if it is applied to a particular subscription.

subscription_itemstring nullable

The subscription item that this coupon is applied to, if it is applied to a particular subscription item.