Get a subscription item applied discount.

cURL

curl -X GET \
 /subscription-item-applied-discounts/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "<string>",
  "subscriptionItem": "https://example.com/",
  "coupon": "https://example.com/",
  "status": "active",
  "discount": {
    "name": "10% off",
    "type": "percentage",
    "frequency": "limited",
    "percentage": 10,
    "fixedAmount": {},
    "frequencyInterval": 3
  },
  "appliedIntervals": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "removed": true,
  "completed": true,
  "active": true,
  "tenantId": "<string>"
}

GET

subscription-item-applied-discounts

{id}

cURL

curl -X GET \
 /subscription-item-applied-discounts/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "<string>",
  "subscriptionItem": "https://example.com/",
  "coupon": "https://example.com/",
  "status": "active",
  "discount": {
    "name": "10% off",
    "type": "percentage",
    "frequency": "limited",
    "percentage": 10,
    "fixedAmount": {},
    "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

string

required

SubscriptionItemAppliedDiscount identifier

Response

SubscriptionItemAppliedDiscount resource

string

subscriptionItem

string<iri-reference>

Example:

"https://example.com/"

coupon

string<iri-reference> | 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.

Example:

"active"

discount

object

The discount that is applied to the subscription item.

Show child attributes

discount.name

string

required

The name of this coupon, which will be displayed to the user in the checkout process, customer front, etc.

Example:

"10% off"

discount.type

any

required

The type of this coupon.

Possible values:

percentage: A percentage will be taken off the total plan amount.
fixed_amount: A fixed amount will be taken off the total plan amount. It will never go below 0.

Example:

"percentage"

discount.frequency

any

required

The frequency at which a coupon should be applied.

Possible values:

once: The coupon will be applied once for the first billing period.
limited: The coupon will be applied for a limited number of billing periods.
lifetime: The coupon will be applied forever.

Example:

"limited"

discount.percentage

integer | null

The percentage this coupon should apply. Required for type percentage.

Required range: 0 <= x <= 100

Example:

10

discount.fixedAmount

object

The fixed amount this coupon should apply. Required for type fixed_amount.

discount.frequencyInterval

integer | null

The number of billing periods the coupon will be applied for. Required for frequency limited.

Example:

3

appliedIntervals

integer | null

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

Example:

1

createdAt

string<date-time>

updatedAt

string<date-time>

removed

boolean

completed

boolean

active

boolean

tenantId

string

Add comment Get a subscription item.

⌘I

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get a subscription item applied discount.

Authorizations

Path Parameters

Response