Skip to content
Wazapin
Esc
↑↓navigate↵open⌘Jpreview

Get hosted checkout upgrade status

GET/v1/settings/billing/upgrade-status
Authorization
bearerAuthbearerAuthrequired
or
apiKeyAuthapiKeyAuthrequired
Query parameters
reference_idstringrequired
Responses
200OK
billingSettingsBillingItemrequired
Show properties
invoicesSettingsBillingInvoiceItem[] | nullrequired
Show properties
Array of SettingsBillingInvoiceItem
billing_profileSettingsBillingProfileSnapshotItemrequired
Show properties
address_line_1stringrequired
address_line_2stringrequired
billing_emailstringrequired
billing_phonestringrequired
citystringrequired
country_codestringrequired
legal_namestringrequired
postal_codestringrequired
state_or_provincestringrequired
tax_idstringrequired
tax_namestringrequired
currencystringrequired
due_atstring
idstringrequired
invoice_numberstringrequired
issued_atstringrequired
latest_reference_idstring
latest_session_statusstring
linesSettingsBillingInvoiceLineItem[] | nullrequired
Show properties
Array of SettingsBillingInvoiceLineItem
descriptionstringrequired
line_totalinteger<int64>required
line_typestringrequired
positioninteger<int32>required
quantityinteger<int32>required
unit_amountinteger<int64>required
notesstring
paid_atstring
period_endstring
period_startstring
statusstringrequired
subtotal_amountinteger<int64>required
target_planstring
tax_amountinteger<int64>required
total_amountinteger<int64>required
limitsSettingsBillingLimitItem[] | nullrequired
Show properties
Array of SettingsBillingLimitItem
keystringrequired
limitinteger<int64>required
usedinteger<int64>required
next_open_invoiceSettingsBillingOpenInvoiceItem
Show properties
currencystringrequired
due_atstring
idstringrequired
invoice_numberstringrequired
latest_reference_idstring
latest_session_statusstring
period_endstring
period_startstring
statusstringrequired
total_amountinteger<int64>required
paymentsSettingsBillingPaymentItem[] | nullrequired
Show properties
Array of SettingsBillingPaymentItem
amountinteger<int64>required
created_atstringrequired
currencystringrequired
idstringrequired
invoice_idstringrequired
invoice_numberstring
methodstring
paid_atstring
providerstringrequired
provider_payment_session_idstring
provider_reference_idstring
statusstringrequired
planstringrequired
profileSettingsBillingProfileSummaryItemrequired
Show properties
completebooleanrequired
missing_fieldsstring[] | nullrequired
profile_completeboolean
profile_missingstring[] | null
renewal_atstringrequired
trial_activebooleanrequired
trial_ends_atstringrequired
walletSettingsBillingWalletItem
Show properties
auto_renew_walletbooleanrequired
balanceinteger<int64>required
currencystringrequired
entitlement_statestringrequired
estimated_monthsinteger<int64>required
grace_started_atstring
min_top_up_amount_idrinteger<int64>required
monthly_renew_amount_idrinteger<int64>required
top_up_presets_idrinteger<int64>[] | nullrequired
invoice_idstring
invoice_numberstring
invoice_statusstring
payment_session_idstringrequired
payment_session_statusstring
reference_idstringrequired
statusstringrequired
400Bad Request
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
401Unauthorized
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
403Forbidden
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
404Not Found
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
422Unprocessable Entity
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
500Internal Server Error
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
Request
curl -X GET "/v1/settings/billing/upgrade-status?reference_id=string"
Response
{
  "billing": {
    "invoices": [
      {
        "billing_profile": {
          "address_line_1": "string",
          "address_line_2": "string",
          "billing_email": "string",
          "billing_phone": "string",
          "city": "string",
          "country_code": "string",
          "legal_name": "string",
          "postal_code": "string",
          "state_or_province": "string",
          "tax_id": "string",
          "tax_name": "string"
        },
        "currency": "string",
        "due_at": "string",
        "id": "string",
        "invoice_number": "string",
        "issued_at": "string",
        "latest_reference_id": "string",
        "latest_session_status": "string",
        "lines": [
          {
            "description": "string",
            "line_total": 0,
            "line_type": "string",
            "position": 0,
            "quantity": 0,
            "unit_amount": 0
          }
        ],
        "notes": "string",
        "paid_at": "string",
        "period_end": "string",
        "period_start": "string",
        "status": "string",
        "subtotal_amount": 0,
        "target_plan": "string",
        "tax_amount": 0,
        "total_amount": 0
      }
    ],
    "limits": [
      {
        "key": "string",
        "limit": 0,
        "used": 0
      }
    ],
    "next_open_invoice": {
      "currency": "string",
      "due_at": "string",
      "id": "string",
      "invoice_number": "string",
      "latest_reference_id": "string",
      "latest_session_status": "string",
      "period_end": "string",
      "period_start": "string",
      "status": "string",
      "total_amount": 0
    },
    "payments": [
      {
        "amount": 0,
        "created_at": "string",
        "currency": "string",
        "id": "string",
        "invoice_id": "string",
        "invoice_number": "string",
        "method": "string",
        "paid_at": "string",
        "provider": "string",
        "provider_payment_session_id": "string",
        "provider_reference_id": "string",
        "status": "string"
      }
    ],
    "plan": "string",
    "profile": {
      "complete": true,
      "missing_fields": [
        "string"
      ]
    },
    "profile_complete": true,
    "profile_missing": [
      "string"
    ],
    "renewal_at": "string",
    "trial_active": true,
    "trial_ends_at": "string",
    "wallet": {
      "auto_renew_wallet": true,
      "balance": 0,
      "currency": "string",
      "entitlement_state": "string",
      "estimated_months": 0,
      "grace_started_at": "string",
      "min_top_up_amount_idr": 0,
      "monthly_renew_amount_idr": 0,
      "top_up_presets_idr": [
        0
      ]
    }
  },
  "invoice_id": "string",
  "invoice_number": "string",
  "invoice_status": "string",
  "payment_session_id": "string",
  "payment_session_status": "string",
  "reference_id": "string",
  "status": "string"
}