Subscription discount resource - Developer documentation

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

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

Reference

string<uuid>

required

resource

enum<string>

required

Available options:

subscription-discount

title

null | string

required

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

Minimum string length: 1

target

object

required

Option 1
Option 2

Show child attributes

target.type

enum<string>

required

Available options:

shipping

value

object

required

Option 1
Option 2

Show child attributes

value.amount

number

required

value.type

enum<string>

required

Available options:

fixed-amount

value.appliesOnEachItem

boolean

required

When true, the amount will be proportionally split among all the items.

recurringCycleLimit

null | integer

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

⌘I

Core Resources

​Reference

Reference