GET
/
subscription-item-applied-discounts
/
{id}
curl -X GET \
 /subscription-item-applied-discounts/{id} \
 --header "Authorization: Bearer <token>"
{
  "id": "<string>",
  "subscriptionItem": "https://example.com/",
  "coupon": "https://example.com/",
  "status": "<any>",
  "discount": {
    "name": "10% off",
    "type": "<any>",
    "percentage": 10,
    "fixedAmount": {},
    "frequency": "<any>",
    "frequencyInterval": 3
  },
  "appliedIntervals": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "removed": true,
  "completed": true,
  "active": true,
  "tenantId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

SubscriptionItemAppliedDiscount identifier

Response

200
application/json
SubscriptionItemAppliedDiscount resource
​
id
string
​
subscriptionItem
string
Example:

"https://example.com/"

​
coupon
string | null
Example:

"https://example.com/"

​
status
any

The status of this applied discount.

Possible values:

  • active: The discount is active and will be applied to the subscription item.
  • completed: The discount is not active anymore, but it was applied to the subscription item.
  • removed: The discount was removed from the subscription item.
​
discount
object

The discount that is applied to the subscription item.

​
appliedIntervals
integer | null

The number of intervals this discount was applied to the subscription item.

Example:

1

​
createdAt
string
​
updatedAt
string
​
removed
boolean
​
completed
boolean
​
active
boolean
​
tenantId
string