Get a specific invoice for the customer

1 min

GET

https://app.amberflo.io/customer-portal/invoice

productIdstringProduct ID as defined in account pricing. Change from default only if you have multiple products.

fromCachebooleanSetting this param to false will cause the service to return cached invoice data (usually a couple of hours lag). This call has better performance than the default. Default to false.

withPaymentStatusbooleanSetting this param to false will cause the service to not fetch the payment status as part of the invoice. Recommended if you don't need the invoice payment status or if the invoice is still in a open state. Default to true.

latestbooleanIf set to true, the service will try to fetch the latest invoice for the given product and customer, otherwise this service will expect a full invoice key (i.e. the product plan id and the invoice start date) Default to false.

productPlanIdstringThe product plan id. If <code>latest</code> is false, this parameter is mandatory, otherwise it is ignored.

yearintegerThe invoice start date (year). If <code>latest</code> is false, this parameter is mandatory, otherwise it is ignored.

monthintegerThe invoice start date (month). If <code>latest</code> is false, this parameter is mandatory, otherwise it is ignored.

dayintegerThe invoice start date (day). If <code>latest</code> is false, this parameter is mandatory, otherwise it is ignored.

sessionTokenstringA required session token used to authenticate API calls made on behalf of a customer. This token is obtained from the <code>Create a session</code> endpoint and must be included with every request to authorize access.

200Successful response

curl --request GET \
     --url 'https://app.amberflo.io/customer-portal/invoice?productId=1&sessionToken=string' \
     --header 'accept: application/json'