BillingPlans: getDowngradeRequestBillingInfo

Request

HTTP request

GET /restapi/v2.1/accounts/{accountId}/billing_plan/downgrade

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

downgradRequestBillingInfoResponse
400

Error encountered.

errorDetails

SDK Method

Billing::getDowngradeRequestBillingInfo

Definitions

downgradePlanUpdateResponse

accountPaymentMethodstring

The type of payment method used for the account. Valid values are:

  • credit_card

downgradeEffectiveDatestring

downgradePaymentCyclestring

downgradePlanIdstring

downgradePlanNamestring

downgradeRequestStatusstring

messagestring

downgradRequestBillingInfoResponse

downgradePlanInformationdowngradePlanUpdateResponse

paymentMethodstring

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />