Billing Plans
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.
Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
Query Parameters
include_credit_card_information?string
When true, payment information including credit card information will show in the return.
include_downgrade_information?string
include_metadata?string
When true, the canUpgrade and renewalStatus properties are included the response and an array of supportedCountries is added to the billingAddress information.
include_successor_plans?string
When true, excludes successor information from the response.
include_tax_exempt_id?string
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/billing_plan"{ "billingAddress": { "address1": "string", "address2": "string", "city": "string", "country": "string", "email": "string", "fax": "string", "firstName": "string", "lastName": "string", "phone": "string", "postalCode": "string", "state": "string", "supportedCountries": [ { "isoCode": "string", "name": "string", "provinces": [ { "isoCode": "string", "name": "string" } ], "provinceValidated": "string" } ] }, "billingAddressIsCreditCardAddress": "string", "billingPlan": { "addOns": [ { "active": "string", "addOnId": "string", "id": "string", "name": "string" } ], "appStoreReceiptExpirationDate": "string", "appStoreReceiptPurchaseDate": "string", "canCancelRenewal": "string", "canUpgrade": "string", "currencyCode": "string", "downgradePlanInformation": { "accountPaymentMethod": "string", "discountApplied": "string", "downgradeEffectiveDate": "string", "downgradePaymentCycle": "string", "downgradePlanId": "string", "downgradePlanName": "string", "downgradeRequestStatus": "string", "message": "string", "productId": "string", "promoCode": "string", "saleDiscount": "string", "saleDiscountPeriods": "string", "saleDiscountType": "string" }, "enableSupport": "string", "includedSeats": "string", "incrementalSeats": "string", "isDowngrade": "string", "notificationType": "string", "otherDiscountPercent": "string", "paymentCycle": "string", "paymentMethod": "string", "perSeatPrice": "string", "planClassification": "string", "planFeatureSets": [ { "currencyFeatureSetPrices": [ { "currencyCode": "string", "currencySymbol": "string", "envelopeFee": "string", "fixedFee": "string", "seatFee": "string" } ], "envelopeFee": "string", "featureSetId": "string", "fixedFee": "string", "is21CFRPart11": "string", "isActive": "string", "isEnabled": "string", "name": "string", "seatFee": "string" } ], "planId": "string", "planName": "string", "planStartDate": "string", "productId": "string", "renewalDate": "string", "renewalStatus": "string", "seatDiscounts": [ { "beginSeatCount": "string", "discountPercent": "string", "endSeatCount": "string" } ], "subscriptionStartDate": "string", "supportIncidentFee": "string", "supportPlanFee": "string", "taxExemptId": "string" }, "creditCardInformation": { "address": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "cardLastDigits": "string", "cardNumber": "string", "cardType": "string", "cvNumber": "string", "expirationMonth": "string", "expirationYear": "string", "nameOnCard": "string", "tokenizedCard": "string" }, "directDebitProcessorInformation": { "bankBranchCode": "string", "bankCheckDigit": "string", "bankCode": "string", "bankName": "string", "bankTransferAccountName": "string", "bankTransferAccountNumber": "string", "bankTransferType": "string", "country": "string", "email": "string", "firstName": "string", "iBAN": "string", "lastName": "string" }, "downgradePlanInformation": { "accountPaymentMethod": "string", "discountApplied": "string", "downgradeEffectiveDate": "string", "downgradePaymentCycle": "string", "downgradePlanId": "string", "downgradePlanName": "string", "downgradeRequestStatus": "string", "message": "string", "productId": "string", "promoCode": "string", "saleDiscount": "string", "saleDiscountPeriods": "string", "saleDiscountType": "string" }, "downgradeRequestInformation": { "downgradeRequestCreation": "string", "downgradeRequestProductId": "string", "downgradeRequestStatus": "string" }, "entityInformation": { "billingProfile": "string", "entityName": "string", "externalEntityId": "string", "isExternallyBilled": "string" }, "paymentMethod": "string", "paymentProcessorInformation": { "address": { "address1": "string", "address2": "string", "city": "string", "country": "string", "fax": "string", "phone": "string", "postalCode": "string", "stateOrProvince": "string", "zipPlus4": "string" }, "billingAgreementId": "string", "email": "string" }, "referralInformation": { "advertisementId": "string", "enableSupport": "string", "externalOrgId": "string", "groupMemberId": "string", "idType": "string", "includedSeats": "string", "industry": "string", "planStartMonth": "string", "promoCode": "string", "publisherId": "string", "referralCode": "string", "referrerName": "string", "saleDiscountAmount": "string", "saleDiscountFixedAmount": "string", "saleDiscountPercent": "string", "saleDiscountPeriods": "string", "saleDiscountSeatPriceOverride": "string", "shopperId": "string" }, "successorPlans": [ { "appStoreProducts": [ { "marketPlace": "string", "productId": "string" } ], "currencyPlanPrices": [ { "currencyCode": "string", "currencySymbol": "string", "perSeatPrice": "string", "supportedCardTypes": { "cardTypes": [ "string" ] }, "supportIncidentFee": "string", "supportPlanFee": "string" } ], "enableSupport": "string", "includedSeats": "string", "otherDiscountPercent": "string", "paymentCycle": "string", "paymentMethod": "string", "perSeatPrice": "string", "planClassification": "string", "planFeatureSets": [ { "currencyFeatureSetPrices": [ { "currencyCode": "string", "currencySymbol": "string", "envelopeFee": "string", "fixedFee": "string", "seatFee": "string" } ], "envelopeFee": "string", "featureSetId": "string", "fixedFee": "string", "is21CFRPart11": "string", "isActive": "string", "isEnabled": "string", "name": "string", "seatFee": "string" } ], "planId": "string", "planName": "string", "seatDiscounts": [ { "beginSeatCount": "string", "discountPercent": "string", "endSeatCount": "string" } ], "supportIncidentFee": "string", "supportPlanFee": "string" } ], "taxExemptId": "string"}