/
Retrieve a plan

Retrieve a plan

Request

Retrieves a plan with a specified ID.

Security
CustomerJWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Query
expandstring

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/plans/{id}?expand=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Plan retrieved.

Bodyapplication/json
idstring, <= 50 characters

ID of the plan.

Example:"plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
namestring, <= 255 charactersrequired

Name of the plan. This name is displayed on invoices and receipts.

descriptionstring

Plain-text description of the plan. This field accepts plain-text only.

richDescriptionstring

Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.

productIdstring, <= 50 charactersrequired

ID of the related product.

Example:"prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"
productOptionsobject or null

Name-value pairs that specify the product options.

Example:
{
  "color": "red",
  "size": "xxl"
}
currencystring, = 3 characters(CurrencyCode)required

Currency code in ISO 4217 format.

Example:"USD"
currencySignstringread-only

Currency sign.

pricingobject(PlanPriceFormula)required
setupobject or null(PlanSetup)

Setup fee information for the plan.

customFieldsobject(ResourceCustomFields)

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

Default:{}
Example:
{
  "foo": "bar"
}
isActiveboolean

Specifies if the plan is active.

Default:true
revisionintegerread-only

Number of times the plan is modified. Compare this value with materialized subscription item revision values.

trialobject or null

Trial configuration setting. If you do not want to offer a trial, set this value to null.

meteredBillingobject or null

Use metered billing when an exact quantity is unknown. Report usage during a service period and charge customers afterwards. Metered billing plans must be postpaid.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "plan_0YV7DENSVGDBW9S71XZNNYYQ0X",
  "name": "string",
  "description": "string",
  "richDescription": "string",
  "productId": "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ",
  "productOptions": {
    "color": "red",
    "size": "xxl"
  },
  "currency": "USD",
  "currencySign": "string",
  "pricing": {
    "formula": "fixed-fee",
    "price": 99.95
  },
  "setup": {
    "price": 0.1
  },
  "customFields": {
    "foo": "bar"
  },
  "isActive": true,
  "revision": 0,
  "trial": {
    "price": 0.1,
    "period": { … }
  },
  "meteredBilling": {
    "strategy": "sum",
    "min": 0.01,
    "max": 0.01,
    "sticky": false
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_embedded": {
    "product": {}
  },
  "_links": [
    { … }
  ]
}