Billing Category

Use the Billing category to manage the following billing related tasks:

  • Retrieve and update billing plan information.
  • Retrieve invoices.
  • Retrieve and update payment information.

BillingPlans

Billing plans

Method Description
get GET /v2/billing_plans/{billingPlanId}

Get the billing plan details.

getAccountPlan GET /v2/accounts/{accountId}/billing_plan

Get Account Billing Plan

getCreditCard GET /v2/accounts/{accountId}/billing_plan/credit_card

Get metadata for a given credit card.

list GET /v2/billing_plans

Gets the list of available billing plans.

purchaseEnvelopes PUT /v2/accounts/{accountId}/billing_plan/purchased_envelopes

Reserverd: Purchase additional envelopes.

update PUT /v2/accounts/{accountId}/billing_plan

Updates the account billing plan.

Invoices

Invoices

Method Description
get GET /v2/accounts/{accountId}/billing_invoices/{invoiceId}

Retrieves a billing invoice.

list GET /v2/accounts/{accountId}/billing_invoices

Get a List of Billing Invoices

listPastDue GET /v2/accounts/{accountId}/billing_invoices_past_due

Get a list of past due invoices.

Payments

Payments

Method Description
create POST /v2/accounts/{accountId}/billing_payments

Posts a payment to a past due invoice.

get GET /v2/accounts/{accountId}/billing_payments/{paymentId}

Gets billing payment information for a specific payment.

list GET /v2/accounts/{accountId}/billing_payments

Gets payment information for one or more payments.