ChargebeeAPI

List contract terms for a subscription

Retrieves a list of contract term resources for the subscription specified in the path.

Sample Request

URL Format

GET https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/contract_terms

Input Parameters

limit
optional, integer, default=10, min=1, max=100

The number of resources to be returned.

offset
optional, string, max chars=1000

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

sort_by[<sort-order>]
optional, object

optional, string filter

Sorts based on the specified attribute. Supported attributes : created_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "created_at"

This will sort the result based on the 'created_at' attribute in ascending (earliest first) order.

Returns

next_offsetoptional, string, max chars=1000

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.

contract_termContract term object
Resource object representing contract_term