Get invoice

GET 
https://euwest.api.elasticpath.com/v2/subscriptions/invoices/:invoice_uuid

Get invoice

Request

Path Parameters

invoice_uuid UUIDrequired

The unique identifier of the invoice.

Responses

200

Success. The details of the invoice are returned.

application/json

Schema

Schema

data SubscriptionInvoice
idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
typeSubscriptionInvoiceType (string)required
This represents the type of resource object being returned. Always subscription_invoice.
Possible values: [subscription_invoice]
Example: subscription_invoice
attributes SubscriptionInvoiceAttributesrequired
billing_period TimePeriodrequired
A period of time between a start and end point.
startdate-timerequired
The date and time a billing period started.
Example: 2017-07-21T17:32:28Z
enddate-timerequired
The date and time a billing period ended.
Example: 2017-07-21T17:32:28Z
invoice_items SubscriptionInvoiceItem[]required
Array [
descriptionstringrequired
A description of the subscribed item.
Example: Magazine issue
price SingleCurrencyPricerequired
A price in a single currency.
currencystringrequired
The three-letter ISO currency code in uppercase, associated with a price.
Possible values: <= 1024 characters
Example: USD
amountint64required
The value as a whole number of the currency's smallest subdivision.
Example: 100
includes_taxboolean
Whether the amount includes any taxes.
Example: true
product_idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
from_time_periodstring
The start date and time of the billing period in this price
Example: 2017-01-10T11:41:19.244842Z
until_time_periodstring
The end date and time of the billing period in this price
Example: 2017-01-10T11:41:19.244842Z
]
tax_items TaxItem[]
Array [
typestringrequired
This represents the type of resource object being returned. Always tax_item.
Possible values: [tax_item]
Example: tax_item
namestring
The name that appears on your customer's invoice and usually describes the specific type of tax, for example, Sales, VAT or GST.
Possible values: <= 1024 characters
Example: GST
codestring
The unique identifier assigned to goods and services for taxation purposes.
Possible values: <= 1024 characters
Example: 20.0 % S
ratedoublerequired
The tax rate is the percentage of the subscription amount that is required to be paid as tax.
Example: 0.2
jurisdictionstring
The geographic area or political entity that has authority to levy and collect taxes.
Possible values: <= 1024 characters
Example: USA
]
outstandingbooleanrequired
The invoice still requires payment if true.
Example: true
numberinteger
A sequential number assigned by the billing run.
Example: 1
tax_requiredbooleanrequired
Whether tax is required for this invoice.
Example: true
payment_retries_limit_reachedbooleanrequired
Whether the limit of payment retries has been reached.
Example: false
updated_atstring
The date and time an invoice was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstring
The date and time an invoice was created.
Example: 2017-01-10T11:41:19.244842Z
manual_payment_pendingbooleanrequired
Whether there is a manual pending payment pending on the invoice.
Example: true
meta SubscriptionInvoiceMetarequired
ownerstringrequired
The owner of a resource, either store or organization.
Example: store
subscription_idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
subscriber_idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
price SingleCurrencyPrice
A price in a single currency.
currencystringrequired
The three-letter ISO currency code in uppercase, associated with a price.
Possible values: <= 1024 characters
Example: USD
amountint64required
The value as a whole number of the currency's smallest subdivision.
Example: 100
includes_taxboolean
Whether the amount includes any taxes.
Example: true
timestamps InvoiceTimestamps
updated_atstringrequired
The date and time a resource was updated.
Example: 2017-01-10T11:41:19.244842Z
created_atstringrequired
The date and time a resource was created.
Example: 2017-01-10T11:41:19.244842Z
taxes_added_atstring
The date and time taxes were added to an invoice.
Example: 2017-01-10T11:41:19.244842Z
proration_events ProrationEvent[]required
Array [
proration_policy_idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
billing_cost_before_prorationint64required
The value as a whole number of the currency's smallest subdivision
Example: 100
refunded_amount_for_unused_planint64required
The value as a whole number of the currency's smallest subdivision.
Example: 100
new_plan_costint64required
The value as a whole number of the currency's smallest subdivision.
Example: 100
prorated_atstringrequired
The date and time the subscription was prorated.
Example: 2017-01-10T11:41:19.244842Z
]

Example (auto)

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_invoice",
    "attributes": {
      "billing_period": {
        "start": "2017-07-21T17:32:28Z",
        "end": "2017-07-21T17:32:28Z"
      },
      "invoice_items": [
        {
          "description": "Magazine issue",
          "price": {
            "currency": "USD",
            "amount": 100,
            "includes_tax": false
          },
          "product_id": "11111111-2222-3333-4444-555555555555",
          "from_time_period": "2017-01-10T11:41:19.244842Z",
          "until_time_period": "2017-01-10T11:41:19.244842Z"
        }
      ],
      "tax_items": [
        {
          "type": "tax_item",
          "name": "GST",
          "code": "20.0 % S",
          "rate": 0.2,
          "jurisdiction": "USA"
        }
      ],
      "outstanding": true,
      "number": 1,
      "tax_required": true,
      "payment_retries_limit_reached": false,
      "updated_at": "2017-01-10T11:41:19.244842Z",
      "created_at": "2017-01-10T11:41:19.244842Z",
      "manual_payment_pending": true
    },
    "meta": {
      "owner": "store",
      "subscription_id": "11111111-2222-3333-4444-555555555555",
      "subscriber_id": "11111111-2222-3333-4444-555555555555",
      "price": {
        "currency": "USD",
        "amount": 100,
        "includes_tax": false
      },
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z",
        "taxes_added_at": "2017-01-10T11:41:19.244842Z"
      },
      "proration_events": [
        {
          "proration_policy_id": "11111111-2222-3333-4444-555555555555",
          "billing_cost_before_proration": 100,
          "refunded_amount_for_unused_plan": 100,
          "new_plan_cost": 100,
          "prorated_at": "2017-01-10T11:41:19.244842Z"
        }
      ]
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/subscriptions/invoices/:invoice_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

invoice_uuid — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!