Sign in
api

get/api/invoices/{invoice_id}/pdf_url/

Path parameters

invoice_idstring required

Either an invoice ID (in the format invoice_<uuid>) or an invoice number (in the format YYMMDD-000001)

Response

invoice_idstring required
invoice_numberstring required
cost_duenumber double required
amountnumber double required
issue_datestring date-time required
payment_status'draft' | 'voided' | 'paid' | 'unpaid' required
  • draft - draft
  • voided - voided
  • paid - paid
  • unpaid - unpaid
external_payment_obj_idstring nullable required
external_payment_obj_type'stripe' | 'braintree' | 'null' nullable required
  • stripe - Stripe
  • braintree - Braintree
external_payment_obj_statusstring nullable
due_datestring date-time nullable required
start_datestring date required
end_datestring date required
invoice_pdfstring uri nullable required

Changes

Changed in 5 of the 50 revisions of this API.2111

  • b5ad57fd7ce91See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 53167871bf12112See the full diff
    • ▲

      response property line_items/items/plan/allOf[LightweightPlanVersion]/version list-of-types was widened by adding types string to media type application/json of response 200

      response-property-list-of-types-widened

    • ●

      added the new intermediate enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      the response required property // became read-only for the status

      response-required-property-became-read-only

    • ○

      the response required property /////// became read-only for the status

      response-required-property-became-read-only

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9b3f22d296b17See the full diff
    • ○

      response property cost_due deprecated

      response-property-deprecated

    • ○

      response property line_items/items/subtotal deprecated

      response-property-deprecated

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      the response required property became not read-only for the status

      response-required-property-became-not-read-only

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 13a0a0eff4721See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 36b48cae00a31See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 145 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog