Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 2.93 KB

InvoicesApi.md

File metadata and controls

94 lines (58 loc) · 2.93 KB

BillaBear{{classname}}

All URIs are relative to https://{customerId}.billabear.cloud/api/v1

Method HTTP request Description
ChargeInvoice Post /invoice/{invoiceId}/charge Charge Invoice
DownloadInvoice Get /invoice/{invoiceId}/download Download Invoice
GetInvoicesForCustomer Get /customer/{customerId}/invoices List Customer Invoices

ChargeInvoice

InlineResponse20012 ChargeInvoice(ctx, invoiceId) Charge Invoice

Attempts to charge a card that is on file for the invoice amount

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
invoiceId string The id of the invoice

Return type

InlineResponse20012

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadInvoice

*os.File DownloadInvoice(ctx, invoiceId) Download Invoice

Returns the pdf blob for the invoice

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
invoiceId string The id of the invoice

Return type

*os.File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInvoicesForCustomer

InlineResponse2004 GetInvoicesForCustomer(ctx, customerId) List Customer Invoices

List Customer Invoices

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId string The id of the customer to retrieve

Return type

InlineResponse2004

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]