Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Billing

API reference descriptions are provided in English to preserve the exact published contract.

Read posted activity of the exact selected billing wallet scope

GET/v1/accounts/{AC}/billing/activity

billing.activity.listSDK operation getV1AccountsByAcBillingActivity

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • currencystring (pattern ^[A-Z]{3}$)query

Read persisted invoice and collection settings for a currency

GET/v1/accounts/{AC}/billing/automation

billing.automation.listSDK operation getV1AccountsByAcBillingAutomation

Reads the selected Live wallet's stored configuration. Null means no configuration exists. Stored provider names do not attest runtime provider readiness. Saved payment identifiers are excluded.

Parameters

  • currencystring (pattern ^[A-Z]{3}$)queryRequired

Configure tax-gated invoicing periods and durable collection retries

PUT/v1/accounts/{AC}/billing/automation

billing.automation.updateSDK operation putV1AccountsByAcBillingAutomation

Request body

  • currencystring (pattern ^[A-Z]{3}$)Required
  • nextPeriodEndstring (date-time)Required
  • nextPeriodStartstring (date-time)Required
  • collectionobject
    Show 3 child attributes
    • paymentIntentIdstring (uuid)Required
    • retryDelaysHoursinteger (0–8760)[]Required
    • stepUpTokenstring (max 4096 chars)Required
  • providerStatementobject
    Show 4 child attributes
    • nextPeriodEndstring (date-time)Required
    • nextPeriodStartstring (date-time)Required
    • providerstring (max 128 chars)Required
    • wabaSidstring (WB… SID)Required

List settled charges with their message, sender, market and evidence

GET/v1/accounts/{AC}/billing/charges

billing.charges.listSDK operation getV1AccountsByAcBillingCharges

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • fromstring (date-time)query
  • tostring (date-time)query
  • senderSidstring (WA… SID)query
  • campaignSidstring (CP… SID)query

Read the selected account billing currency without granting organization administration

GET/v1/accounts/{AC}/billing/context

billing.context.listSDK operation getV1AccountsByAcBillingContext

List durable invoices without exposing payment-provider credentials

GET/v1/accounts/{AC}/billing/invoices

billing.invoices.listSDK operation getV1AccountsByAcBillingInvoices

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • currencystring (pattern ^[A-Z]{3}$)query
  • createdAfterstring (date-time)query
  • createdBeforestring (date-time)query
  • stateenumquery

    draftpending_provideropenpast_duepaidvoiduncollectiblefailed

Fetch an invoice and its immutable line references

GET/v1/accounts/{AC}/billing/invoices/{IN}

billing.invoices.retrieveSDK operation getV1AccountsByAcBillingInvoicesByIn

Parameters

  • INstring (IN… SID)Required

Prepare a secure checkout for the reviewed outstanding invoice balance

POST/v1/accounts/{AC}/billing/invoices/{IN}/checkout

billing.invoices.checkoutSDK operation postV1AccountsByAcBillingInvoicesByInCheckout

Parameters

  • INstring (IN… SID)Required

Request body

  • amountMinorstring (pattern ^[1-9][0-9]{0,18}$)Required
  • currencystring (pattern ^[A-Z]{3}$)Required
  • idempotencyKeystring (max 255 chars)Required
  • scaleinteger (0–9)Required
  • stepUpTokenstring (max 4096 chars)Required
  • saveCardForInvoicesboolean

Re-queue a terminally failed invoice submission

POST/v1/accounts/{AC}/billing/invoices/{IN}/resubmit

billing.invoices.resubmitSDK operation postV1AccountsByAcBillingInvoicesByInResubmit

Parameters

  • INstring (IN… SID)Required

Request body

  • stepUpTokenstring (max 256 chars)Required

Read the low-balance alert of each live wallet

GET/v1/accounts/{AC}/billing/low-balance-alerts

billing.lowBalanceAlerts.listSDK operation getV1AccountsByAcBillingLowBalanceAlerts

Set the balance below which the wallet warns its owners

PUT/v1/accounts/{AC}/billing/low-balance-alerts/{currency}

billing.lowBalanceAlerts.updateSDK operation putV1AccountsByAcBillingLowBalanceAlertsByCurrency

Parameters

  • currencystring (pattern ^[A-Z]{3}$)Required

Request body

  • thresholdstring (pattern ^[0-9][0-9,]*(\.[0-9]+)?$, max 24 chars) | nullRequired

Quote one message from the effective immutable pricing fact

POST/v1/accounts/{AC}/billing/message-quote

billing.messageQuoteSDK operation postV1AccountsByAcBillingMessageQuote

Request body

  • categorystring (pattern ^[A-Z][A-Z0-9_]{0,63}$)Required
  • identifierTypeenumRequired

    PHONE_E164BSUIDUSERNAME

  • recipientstring (max 512 chars)Required
  • senderSidstring (WA… SID)Required
  • transportenum

    CLOUD_APIMARKETING_MESSAGES

List payment lifecycle state without exposing payment credentials

GET/v1/accounts/{AC}/billing/payments

billing.payments.listSDK operation getV1AccountsByAcBillingPayments

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • statestring (max 64 chars)query

What this account is charged per message, in force today

GET/v1/accounts/{AC}/billing/rate-card

billing.rateCard.listSDK operation getV1AccountsByAcBillingRateCard

The same effective-dated pricing facts the quote and the settlement read, filtered to what the account holder is actually charged. The admin listing beside this one needs platform:configure, which no customer holds, so until now a business could be charged a rate it had no way to read. Provider cost and margin are deliberately absent: what the platform pays Meta is not the customer's charge and showing it would invite the two to be confused.

List the receipts issued for captured wallet top-ups

GET/v1/accounts/{AC}/billing/receipts

billing.receipts.listSDK operation getV1AccountsByAcBillingReceipts

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Fetch a top-up receipt with its immutable document

GET/v1/accounts/{AC}/billing/receipts/{RC}

billing.receipts.retrieveSDK operation getV1AccountsByAcBillingReceiptsByRc

Parameters

  • RCstring (RC… SID)Required

List reconciliation discrepancies with their statement evidence

GET/v1/accounts/{AC}/billing/reconciliation-cases

billing.reconciliationCases.listSDK operation getV1AccountsByAcBillingReconciliationCases

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • stateenumquery

    openinvestigatingresolvedrejected

  • outcomeenumquery

    amount_mismatchmissing_platform_eventunexpected_provider_chargemissing_provider_status

Fetch one reconciliation discrepancy and its evidence

GET/v1/accounts/{AC}/billing/reconciliation-cases/{CS}

billing.reconciliationCases.retrieveSDK operation getV1AccountsByAcBillingReconciliationCasesByCs

Parameters

  • CSstring (CS… SID)Required

Resolve a reconciliation case with append-only operator evidence

POST/v1/accounts/{AC}/billing/reconciliation-cases/{CS}/resolve

billing.reconciliationCases.resolveSDK operation postV1AccountsByAcBillingReconciliationCasesByCsResolve

Parameters

  • CSstring (CS… SID)Required

Request body

  • evidenceobjectRequired
  • reasonstring (max 500 chars)Required
  • resolutionenumRequired

    resolvedrejected

List monthly statements for prepaid wallets

GET/v1/accounts/{AC}/billing/statements

billing.statements.listSDK operation getV1AccountsByAcBillingStatements

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Generate a current-period statement from actual posted wallet ledger entries

GET/v1/accounts/{AC}/billing/statements/as-of

billing.statements.asOf.listSDK operation getV1AccountsByAcBillingStatementsAsOf

Parameters

  • currencystring (pattern ^[A-Z]{3}$)queryRequired

Fetch a monthly statement with its immutable document

GET/v1/accounts/{AC}/billing/statements/{ST}

billing.statements.retrieveSDK operation getV1AccountsByAcBillingStatementsBySt

Parameters

  • STstring (ST… SID)Required

Read the invoice tax profile and schedule for a currency

GET/v1/accounts/{AC}/billing/tax-profile

billing.taxProfile.listSDK operation getV1AccountsByAcBillingTaxProfile

Reads the selected Live wallet's stored configuration. Null means no configuration exists. Stored provider names do not attest runtime provider readiness. Saved payment identifiers are excluded.

Parameters

  • currencystring (pattern ^[A-Z]{3}$)queryRequired

Start provider-hosted wallet funding

POST/v1/accounts/{AC}/billing/top-ups

billing.topUpsSDK operation postV1AccountsByAcBillingTopUps

Request body

  • amountMinorstring (pattern ^[1-9][0-9]{0,7}$)Required
  • currencystring (pattern ^[A-Z]{3}$)Required
  • idempotencyKeystring (max 255 chars)Required
  • stepUpTokenstring (max 4096 chars)Required
  • saveCardForInvoicesboolean

Read exact outbound and inbound message pricing receipts, including fractional usage

GET/v1/accounts/{AC}/billing/usage-receipts

billing.usageReceipts.listSDK operation getV1AccountsByAcBillingUsageReceipts

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • fromstring (date-time)query
  • tostring (date-time)query

List billing wallets and ledger-derived available funds

GET/v1/accounts/{AC}/billing/wallets

billing.wallets.listSDK operation getV1AccountsByAcBillingWallets

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query
  • currencystring (pattern ^[A-Z]{3}$)query
  • commercialModeenumquery

    prepaidpostpaidcredit_lineinvoicehybrid

  • billingStatusstring (max 64 chars)query
  • dunningStatestring (max 64 chars)query

Fetch the effective WABA billing mode and migration state

GET/v1/accounts/{AC}/wabas/{WB}/billing-mode

wabas.billingMode.listSDK operation getV1AccountsByAcWabasByWbBillingMode

Parameters

  • WBstring (WB… SID)Required

Start a safely gated migration to partner billing

POST/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch

wabas.billingModeSwitchSDK operation postV1AccountsByAcWabasByWbBillingModeSwitch

Parameters

  • WBstring (WB… SID)Required

Accept partner-billing terms with a single-use MFA step-up grant

POST/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch/accept

wabas.billingModeSwitch.acceptSDK operation postV1AccountsByAcWabasByWbBillingModeSwitchAccept

Parameters

  • WBstring (WB… SID)Required

Request body

  • stepUpEvidencestring (max 4096 chars)Required
  • termsVersionstring (max 128 chars)Required

Revert partner billing only after durable Meta credit-allocation revocation

POST/v1/accounts/{AC}/wabas/{WB}/billing-mode-switch/revert

wabas.billingModeSwitch.revertSDK operation postV1AccountsByAcWabasByWbBillingModeSwitchRevert

Parameters

  • WBstring (WB… SID)Required

Request body

  • idempotencyKeystring (max 255 chars)Required
  • reason"customer_disconnected"Required

The published platform rate card

GET/v1/pricing

pricing.listSDK operation getV1Pricing

What Toutye charges per delivered message, by category, pricing type, transport, market and currency. Meta bills the business directly for the conversation itself; this fee is the entire Toutye charge. Public: no key is needed to read a price.