List jobs

GET 
https://euwest.api.elasticpath.com/v2/subscriptions/jobs

Retrieves a list of all jobs.

Filtering

This endpoint supports filtering. For the general syntax, see Filtering.

The following attributes and operators are supported.

Operator	Attribute	Description
eq	external_ref	Equals. Checks if the values of two operands are equal. If they are, the condition is true.

Request

Query Parameters

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int64

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

filter string

Responses

200

Success. A list of jobs is returned.

application/json

Schema

Schema

data Job[]
Array [
idUUID (string)
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
typeSubscriptionJobType (string)required
Possible values: [subscription_job]
Example: subscription_job
attributes JobResponseAttributes
external_refExternalRef (string)
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
Possible values: <= 2048 characters
Example: abc123
job_typeJobType (string)required
The type of job. One of the following:
• billing_run - a billing run job.
• payment_run - a payment run job.
• tax_run - a tax run job.
Possible values: [billing-run, tax-run, payment-run, import]
Example: billing-run
taxes InvoiceTaxItems[]
Possible values: >= 1
Array [
invoice_idUUID (string)required
The unique identifier.
Example: 11111111-2222-3333-4444-555555555555
tax_items TaxItem[]required
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
]
]
statusstringrequired
The status of job.
Possible values: [pending, started, success, failed]
Example: pending
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
relationships Relationships
Relationships are established between different subscription entities. For example, a product and a plan are related to an offering, as both are attached to it.
property name* Relationship
anyOf
SingleRelationship
ManyRelationship
meta JobMetarequired
ownerstringrequired
The owner of a resource, either store or organization.
Example: store
timestamps JobTimestamps
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
started_atstring
The date and time a job is started.
Example: 2017-01-10T11:41:19.244842Z
finished_atstring
The date and time a job finished.
Example: 2017-01-10T11:41:19.244842Z
report object
You can track your Subscriptions billing, tax, and payment operations using reports.
oneOf
BillingRunReport
TaxRunReport
PaymentRunReport
]
links object
property name* Link
anyOf
LinkURI
stringnullable
Example: http://example.com/articles/1/comments
LinkObject
hrefuri
Example: http://example.com/articles/1/comments
titlestring
Example: Comments
describedbyuri
Example: http://example.com/schemas/article-comments

Example (auto)

{
  "data": [
    {
      "id": "11111111-2222-3333-4444-555555555555",
      "type": "subscription_job",
      "attributes": {
        "external_ref": "abc123",
        "job_type": "billing-run",
        "taxes": [
          {
            "invoice_id": "11111111-2222-3333-4444-555555555555",
            "tax_items": [
              {
                "type": "tax_item",
                "name": "GST",
                "code": "20.0 % S",
                "rate": 0.2,
                "jurisdiction": "USA"
              }
            ]
          }
        ],
        "status": "pending",
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "relationships": {
        "plans": {
          "links": {
            "related": "/offerings/:offering-id/plans",
            "self": "/offerings/:offering-id"
          },
          "data": {
            "type": "offering-plan",
            "id": "625fe958-7b4b-40a0-a2c0-dbb8f31eec0d"
          }
        }
      },
      "meta": {
        "owner": "store",
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z",
          "started_at": "2017-01-10T11:41:19.244842Z",
          "finished_at": "2017-01-10T11:41:19.244842Z"
        },
        "report": {
          "invoices_ready_for_payment": 100,
          "invoices_tax_required": 100,
          "invoice_failures": 0,
          "total_ready_for_payment": {
            "USD": {
              "amount": 100,
              "includes_tax": false
            },
            "GBP": {
              "amount": 90,
              "includes_tax": true
            }
          },
          "total_tax_required": {
            "USD": {
              "amount": 100,
              "includes_tax": false
            },
            "GBP": {
              "amount": 90,
              "includes_tax": true
            }
          }
        }
      }
    }
  ],
  "links": {}
}

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/jobs");
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

page[offset] — query

page[limit] — query

filter — query

ResponseClear

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