Gets a list of subscription billing options and related data from active subscriptions

Billing options of inactive subscriptions are not returned, as they can not be purchased.

Licenses Required

Vista.Ocapi
Vista.Subscriptions

Request

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

get/ocapi/v1/subscription-billing-options

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"billingOptions": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"prices": [{"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"isDefault": true,
"discount": {"calculation": {"percentageOff": 0.1,
"type": "SpecialPrice"
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
}
},
"restrictions": ["Discount"
],
"discountId": "string"
}
],
"subscriptionId": 0,
"billingPeriodInMonths": 0,
"isRecurring": true
}
],
"relatedData": {"subscriptions": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"clubId": 0,
"minimumTermInMonths": 0,
"minimumTermBeforeCanPurchaseFutureSubscriptionInMonths": 0
}
],
"discounts": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"restriction": "None",
"restrictions": ["None"
],
"rewardIds": [0
],
"voucherTypeCodes": ["string"
],
"expiresAt": "2019-08-24T14:15:22Z"
}
]
}
}