GuidesAPI ReferenceSupport
API Reference

Read Plan

get
https://secure.fusebill.com/v1/Plans/

Retrieve a Plan or subscription template based on a plan by a plan's unique plan ID. It can also be used to get a clean subscription object template for making a subscription.

Typically this will return a plan and details about products and pricing in that plan.

Use the query parameter view with value subscription to get a clean subscription post payload example. This is especially effective when combined with values for interval and numberOfIntervals.

Using a subscription view payload can help to greatly reduce the effort in defining a subscription, or reducing the number of calls to create a subscription (since the object can then be modified before the first post).

Path Params
int32
required

This is the ID value which uniquely identifies this Plan in the Fusebill system. This value is unique to each Plan. This is the Id of the Plan you want to retrieve.

Query Params
string
enum

Changes the returned payload. Setting it to "subscription" will return a subscription creation payload.

Allowed:
string
enum

Select which base the subscription billing period is built out of.

Allowed:
int32

Number of intervals in a billing period. This is combined with interval to find the correct payload to return.

string

Pricing will be returned for the specific currency (when set in the catalog) for when view is subscription

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago