Subscription discount resource - Developer documentation

The SubscriptionDiscount object is used to apply discounts to subscription items, reducing the product price for subscribers.

Reference

string

required

resource

enum<string>

required

Available options:

subscription-discount

title

string | null

required

The title of the discount shown to customers, typically displayed as a discount code.

Minimum length: 1

target

object

required

value

object

required

recurringCycleLimit

integer | null

required

The number of billing cycles for which this discount will be applied. After the recurring cycle limit is met the discount will be removed from the subscription.

Required range: x >= 1

Delete subscription item Create a subscription discount

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "subscription-discount",
  "title": null,
  "target": {
    "type": "shipping"
  },
  "value": {
    "amount": 123,
    "type": "fixed-amount",
    "appliesOnEachItem": true
  },
  "recurringCycleLimit": null
}

Core Resources

​Reference

Reference