Recurring price attributes.
Recurring
| Name | Type | Tags | Description | Getter |
|---|---|---|---|---|
interval |
Enum |
Optional | Specifies billing frequency. One of WEEK, MONTH or YEAR. |
String getInterval() |
intervalCount |
Integer |
Optional | The number of intervals between subscription billings. For example, interval=MONTH and intervalCount=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). |
String getIntervalCount() |
alignment |
Enum |
Optional | How to align billing for recurring (subscription) products that start on different days. | String getAlignment() |
usage |
boolean |
Optional | Indicates that this is a usage price. | boolean getUsage() |
formula |
String |
Optional | The pricing formula used to calculate the charge amount. | boolean getFormula() |
on |
Enum |
Optional | Specifies on which day of the month or day of the week a customer shall be billed. | String getRecurringOn() |
timing |
Enum |
Optional | You can choose to bill IN_ADVANCE or IN_ARREARS for recurring prices. This field is not used with one-time or usage-based prices. |
String getTiming() |
durationInterval |
Enum |
Optional | Specifies duration frequency. One of DAY, WEEK, MONTH or YEAR. |
String getDurationInterval() |
durationIntervalCount |
Integer |
Optional | Specifies the how long a customer shall be charged if this is less than the duration of the subscription. | String getDurationIntervalCount() |
ratingGroup |
Enum |
Optional | One of BILLING_PERIOD, USAGE_START_DATE, USAGE_RECORD, USAGE_UPLOAD or CUSTOM_GROUP. |
String getRatingGroup() |