younifyd
Menu

Create Job

Create a job

POST/v2/subscriptions/jobs

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Create Job action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{createJob.response.data}}.

Request

Query parameters

filterstring (string)

Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
typestringrequired

One ofsubscription_job

attributesobjectrequired2 fields
json
{
  "data": {
    "type": "subscription_job",
    "attributes": {
      "job_type": "billing-run",
      "external_ref": "abc123"
    }
  }
}

Response

Returns 201 with an object. Read it in later steps with {{createJob.response.data.<field>}}.

dataobject
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_job

attributesanyrequired
relationshipsany

Relationships are established between different subscription entities. For example, a plan and a pricing option are related to an offering, as both are attached to it.

metaobjectrequired3 fields
json
{
  "data": {
    "type": "subscription_job",
    "attributes": null,
    "meta": {
      "owner": "store",
      "timestamps": null,
      "report": null
    },
    "id": "11111111-2222-3333-4444-555555555555",
    "relationships": {
      "pricing-options": {
        "links": {
          "related": "/offerings/:offering-id/pricing-options",
          "self": "/offerings/:offering-id"
        },
        "data": {
          "type": "offering-pricing-option",
          "id": "625fe958-7b4b-40a0-a2c0-dbb8f31eec0d"
        }
      }
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.