v1

latestSwagger 2.02026-07-134146194.6 MB
BillingPlans

Get Account Billing Plan

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to false.

Response

The response returns the billing plan information, including the currency code, for the plan. The billingPlan and succesorPlans property values are the same as those shown in the Billing: getBillingPlan reference. the billingAddress and creditCardInformation property values are the same as those shown in the Billing: updatePlan reference.

Note: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.

get/v2.1/accounts/{accountId}/billing_plan

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Query parameters

include_credit_card_informationstring

When true, payment information including credit card information will show in the return.

include_downgrade_informationstring
include_metadatastring

When true, the canUpgrade and renewalStatus properties are included the response and an array of supportedCountries is added to the billingAddress information.

include_successor_plansstring

When true, excludes successor information from the response.

include_tax_exempt_idstring

Response

Successful response.