v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131541,3491.5 MB
customers

Returns all invoices associated with a billing setup, for a given month. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

get/v23/customers/{+customerId}/invoices

Path parameters

customerIdstring required

Required. The ID of the customer to fetch invoices for.

Query parameters

billingSetupstring

Required. The billing setup resource name of the requested invoices. customers/{customer_id}/billingSetups/{billing_setup_id}

includeGranularLevelInvoiceDetailsboolean

Optional. When true, the response will include more granular level invoice details such as campaign level cost breakdown, itemized regulatory costs and adjustments. The default value is false.

issueMonth'UNSPECIFIED' | 'UNKNOWN' | 'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'

Required. The issue month to retrieve invoices.

issueYearstring

Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved.

Response

Successful response