Settings
API Version
Product Catalog
Library

Downloads

Requesting to download a file through this API will return the download_url attribute as the response. This attribute will contain a URL that will allow the requested content to be downloaded.

Sample download [ JSON ]

{ "download_url": "https://cb-downloads-dev.s3.amazonaws.com//invoice_rI8lOV4vCCpI.pdf", "valid_till": 1528093653 }

API Index URL GET

https://{site}.chargebee.com/api/v2/downloads

Model Class

 

      Download attributes
      
 
download_url
 

      string, max chars=3500
 The URL at which the file is available for download. 
 
 
valid_till
 

      timestamp(UTC) in seconds
 The time until which the download_url is valid. 
 
 
mime_type
 

      optional, string, max chars=100
 The media type of the file. 
 
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
download_url download_url
 

          string, max chars=3500
 The URL at which the file is available for download. 
 
valid_till valid_till
 

          timestamp(UTC) in seconds
 The time until which the download_url is valid. 
 
mime_type mime_type
 

          optional, string, max chars=100
 The media type of the file. 
 
 
 
Consent Fields for Download
 
 
Custom Fields for Download