Get all Base Plans

GET 
/v1/organizations/:organizationId/projects/:projectId/platforms/android/subscriptions/:productId/base-plans

Get all Base Plans

Request

Path Parameters

organizationId stringrequired
projectId stringrequired
productId stringrequired

Query Parameters

includeOffers booleanrequired
includePrices booleanrequired
page numberrequired
Possible values: >= 1
Default value: 1
Page number starting from 1.
Example: 1
limit numberrequired
Possible values: >= 1 and <= 100
Default value: 10
Limit the number of results returned. Default is 10.
Example: 10

Responses

200

Get all Base Plans

application/json

Schema

Schema

data object[]required
Array [
id stringrequired
The unique identifier of the base plan
name stringrequired
Possible values: Value must match regular expression /^[a-z0-9][a-zA-Z0-9_\.]*$/
The unique name of the base plan
type stringrequired
Possible values: [auto_renewing, prepaid]
Type of the base plan
tags string[]required
Possible values: Value must match regular expression /^[a-z][a-z0-9-]{0,19}$/
Tags associated with the base plan
offers object[]
The offers associated with the base plan
Array [
id stringrequired
The unique identifier for the offer.
name stringrequired
The unique name identifier for the offer.
duration stringrequired
Possible values: Value must match regular expression /^P(\d+[YMWD])+$/
The duration of the offer.
eligibility stringrequired
Possible values: [new_customer_acquisition, upgrade, developer_determined]
The eligibility criteria for the offer.
tags string[]required
Tags associated with the offer.
phases object[]
The phases associated with the offer.
Array [
id stringrequired
The unique identifier for the phase.
type PhaseTyperequired
Possible values: [introductory_price, regular, trial, free_trial, discounted_recurring_payment, single_payment]
The type of the phase.
duration stringrequired
Duration of the phase
priceOverride stringrequired
Possible values: [fixed_amount, percentage_discount, absolute_discount]
Override type for the phase price
billingPeriods numberrequired
Number of billing periods for which the override applies
prices object[]
Prices and availability for different countries
Array [
country stringrequired
The country code
priceAmountMicros int64required
The price
]
]
active booleanrequired
Indicates if the offer is active.
createdAt date-timerequired
The creation date of the base plan
updatedAt date-timerequired
The last update date of the base plan
]
billingPeriod stringrequired
Possible values: Value must match regular expression /^P(\d+[YMWD])+$/
The billing period of the base plan
gracePeriod stringrequired
Possible values: Value must match regular expression /^P(\d+[YMWD])+$/
The grace period of the base plan
customerChanges stringrequired
Possible values: [charge_at_next_billing_date, charge_immediately]
The customer changes of the base plan
resubscribe stringrequired
Possible values: [allow, dont_allow]
The resubscribe option of the base plan
duration stringrequired
Possible values: Value must match regular expression /^P(\d+[YMWD])+$/
The duration of the base plan
allowExtension stringrequired
Possible values: [allow, dont_allow]
The extension allowance of the base plan
countryCount numberrequired
The count of countries with defined prices in the base plan
prices object[]
The list of countries with defined prices in the base plan
Array [
country stringrequired
The country code
priceAmountMicros int64required
The price
]
deactivatedAt date-timerequired
The status of the base plan
createdAt date-timerequired
The creation date of the base plan
updatedAt date-timerequired
The last update date of the base plan
]
metadata objectrequired

currentPage numberrequired

The current page number.

limit numberrequired

Number of items per page.

total numberrequired

Total number of items.

nextPage numbernullablerequired

The next page number, or null if this is the last page.

previousPage numbernullablerequired

The previous page number, or null if this is the first page.

Example (from schema)

{
  "data": [
    {
      "id": "1234",
      "name": "my_baseplan_1234",
      "type": "auto_renewing",
      "tags": [
        "tag1",
        "tag2"
      ],
      "offers": [
        {
          "id": "abc123",
          "name": "abc123",
          "duration": "30 days",
          "eligibility": "new_customer_acquisition",
          "tags": [
            "tag1",
            "tag2"
          ],
          "phases": [
            {
              "id": "abc123",
              "type": "free_trial",
              "duration": "P7D",
              "priceOverride": "fixed_amount",
              "billingPeriods": 3,
              "prices": [
                {
                  "country": "US",
                  "priceAmountMicros": 19990000,
                  "currency": "USD"
                }
              ]
            }
          ],
          "active": true,
          "createdAt": "2022-01-01",
          "updatedAt": "2022-01-02"
        }
      ],
      "billingPeriod": "P1M",
      "gracePeriod": "P3D",
      "customerChanges": "charge_immediately",
      "resubscribe": "allow",
      "duration": "P1Y",
      "allowExtension": "allow",
      "countryCount": "10",
      "prices": [
        {
          "country": "US",
          "price": 10
        },
        {
          "country": "GB",
          "price": 15
        }
      ],
      "deactivatedAt": "active",
      "createdAt": "2022-01-01",
      "updatedAt": "2022-01-02"
    }
  ],
  "metadata": {
    "currentPage": 1,
    "limit": 10,
    "total": 100,
    "nextPage": 2,
    "previousPage": null
  }
}

400

Bad Request

Loading...