Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Subscriptions

List contractor subscriptions

Endpoint that can be used to list contractor subscriptions.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View employments (employment:read)Manage employments (employment:write)
get/v1/contractors/employments/{employment_id}/contractor-subscriptions

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": [
    {
      "company_product": {
        "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      },
      "company_product_discount": {
        "expiration_date": "2021-07-01",
        "percent": "-123.456"
      },
      "currency": {
        "code": "EUR",
        "name": "European Euro",
        "slug": "eur-3b840951-099f-4bd5-90b9-032f7bfe51d9",
        "symbol": "€"
      },
      "eligibility_questionnaire": {
        "is_blocking": true,
        "questions": {
          "question_key1": "This is the label of the question",
          "question_key2": "This is another question label"
        },
        "responses": {
          "question_key1": "yes",
          "question_key2": "no"
        },
        "slug": "fd32b683-a94a-4496-a0c4-726c088af483",
        "submitted_at": "2021-07-15T18:18:17",
        "type": "contractor_of_record"
      },
      "price": {
        "amount": 2900,
        "final_amount": 2610
      },
      "product": {
        "description": "EOR Monthly",
        "features": [
          "Feature 1",
          "Feature 2"
        ],
        "frequency": "monthly",
        "name": "EOR Monthly",
        "short_name": "EOR",
        "tier": "standard"
      },
      "total_amount": 5800,
      "total_discount": 1000,
      "total_in_advance": 2800,
      "total_prorated": 3000
    }
  ]
}