get/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount

GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

Path parameters

Name	Description
customer*
subscription_exposed_id*

Query parameters

Name	Description
expand	Specifies which fields in the response should be expanded.

Request body

object (no properties in spec)

Response

Field Type Description

checkout_session

string

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

string | customer | deleted_customer

The ID of the customer associated with this discount.

customer_account

string

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

end

integer (unix-time)

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.

id*

string

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.

invoice

string

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

invoice_item

string

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*

string

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

promotion_code

string | promotion_code

The promotion code applied to create this discount.

source*

discount_source

2 nested fields

Field	Type	Description
coupon	string \| coupon	The coupon that was redeemed to create this discount.
type*	string	The source type of the discount.

start*

integer (unix-time)

Date that the coupon was applied.

subscription

string

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

subscription_item

string

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