LogoLogo
System status
Admin APIs reference
Admin APIs reference
  • Admin APIs reference
  • Order management
    • Refunds
    • Retrieve an order (synchronous API)
    • Retrieve an invoice (synchronous API)
    • Manage orders (synchronous API)
  • Customer management
    • Retrieve a customer (synchronous API)
    • Manage a customer (synchronous API)
  • Subscription mangement
    • Manage a subscription
    • Renew a subscription
    • Apply an immediate midterm change
    • Manage subscription payments
    • Modify the subscription's external reference ID
    • Manage the subscription's address
    • Get all orders
    • Retrieve subscriptions with pending actions
    • Retrieve subscriptions
    • Manage a perpetual price
    • Update a subscription's email address
  • Site management
    • Get authorized countries
  • Product management
    • Manage products (asynchronous API)
    • Retrieve a product (synchronous API)
    • Retrieve the product task status (synchronous API)
  • Offer Management
    • Manage offers (synchronous API)
    • Retrieve an offer (synchronous API)
  • Webhook management
    • Manage webhook events
  • Payment source
    • Source management
  • File management
    • Retrieve a file
Powered by GitBook
On this page
  1. Order management

Retrieve an invoice (synchronous API)

PreviousRetrieve an order (synchronous API)NextManage orders (synchronous API)

Last updated 10 months ago

Download the invoice PDF of the order

get

Download the invoice PDF file of an order.

Authorizations
Path parameters
orderIdstringRequired

The identifier of the Order.

receiptIdstringRequired

The receipt identifier of the invoice.

Responses
200
Successful response with PDF file.
application/pdf
Responsestring ยท binary
400
* Bad request.
application/json
401
* Please verify your API key and secret (if applicable) is correct.
404
* Receipt was not found.
application/json
get
GET /v1/orders/{orderId}/invoices/{receiptId} HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Accept: */*
binary

Get the invoice download information of an order

get

Get the invoice data of an order in the response which includes invoice's type and download URL.

Authorizations
Path parameters
orderIdstringRequired

The identifier of the Order.

Responses
200
Successful response.
application/json
400
* Bad request.
application/json
401
* Please verify your API key and secret (if applicable) is correct.
404
* Order was not found or not transferred or in open state.
application/json
get
GET /v1/orders/{orderId}/invoices HTTP/1.1
Host: api.digitalriver.com
Authorization: Basic username:password
Accept: */*
{
  "invoices": []
}
  • GETDownload the invoice PDF of the order
  • GETGet the invoice download information of an order