API Documentation

API Endpoint

Organization Subscriptions

Organization Subscriptions

Supported Enumerations

Payment methods:

  • credit_card (payment_method_id: 1)

  • invoice (payment_method_id: 2)

GET /api/v2/organization_subscriptions/1
Requestsreturns organization subscriptionreturns organization subscription

GET  /api/v2/organization_subscriptions/824

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "824",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 1,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "824"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

GET  /api/v2/organization_subscriptions/848

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "848",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 1,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 24,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "premium",
        "name": "Premium",
        "type": null,
        "monthly_price_cents": 2400,
        "yearly_price_cents": 24000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": true,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": false,
        "cycle_change_error": "plan_discontinued",
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "premium",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "848"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a organization subscription
GET/api/v2/organization_subscriptions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

organization subscription id

PATCH /api/v2/organization_subscriptions/1
Requestscreates subscriptionsets trial plansets trial plandoes not change trial plandoes not change trial plansets trial_plan to nullupdates subscriptionupdates subscriptionupdates subscriptionupdates subscriptionupdates subscriptionupdates subscriptionupdates subscriptionreturns errorcreates subscriptionsets trial plan when plan is set upon monthly standard plandoes not change trial plan when plan changes cycledoes not change trial plan when plan changesets trial_plan to null when undefinedraises error when cycle changed from monthly to yearlyraises error when switching from standard to premiumraises error when switching from standard to new premiumraises error when switching from new premium to standardis invalid when switching from new premium to gated ultimateraises error when switching from premium yearly to standard monthlyupdates subscription

PATCH  /api/v2/organization_subscriptions/825

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "stripe_token": "tok_u5dg20Gra",
      "seats": 3
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "825",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 3,
      "seats_used": 1,
      "seats_pending": 3,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_without_subs",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "825"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/826

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "trial_plan_type": "professional_2026"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "826",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 2,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 120,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-15 23:59:59",
      "trial_plan_type": "professional_2026",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "826"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/827

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "trial_plan_type": "professional_2026",
      "plan_cycle": "year"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "827",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 2,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 120,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-15 23:59:59",
      "trial_plan_type": "professional_2026",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "827"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/828

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "year"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "828",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 108,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "new_essential",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1100,
        "yearly_price_cents": 10800,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "new_essential",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-08 23:59:59",
      "trial_plan_type": "ultimate",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "828"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/829

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "professional_2026"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "829",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 29,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "professional_2026",
        "name": "Professional",
        "type": null,
        "monthly_price_cents": 2900,
        "yearly_price_cents": 30000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [
          "essential_2026"
        ],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          }
        ]
      },
      "plan_type": "professional_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-08 23:59:59",
      "trial_plan_type": "professional_2026",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "829"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/830

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "trial_plan_type": null
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "830",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 288,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "professional",
        "name": "Professional",
        "type": null,
        "monthly_price_cents": 2800,
        "yearly_price_cents": 28800,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [
          "essential_2026"
        ],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          }
        ]
      },
      "plan_type": "professional",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-08 23:59:59",
      "trial_plan_type": null,
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "830"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/831

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "year"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "831",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 120,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "831"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/832

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "professional_2026"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "832",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 29,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "professional_2026",
        "name": "Professional",
        "type": null,
        "monthly_price_cents": 2900,
        "yearly_price_cents": 30000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [
          "essential_2026"
        ],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          }
        ]
      },
      "plan_type": "professional_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "832"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/833

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "essential_2026",
      "plan_cycle": "month"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "833",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "833"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/834

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "month"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "834",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "834"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/835

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "active_products": {
        "hris_integration": {
          "id": "hris_200"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "835",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [
          {
            "stripe_id": "addon_hris_200_monthly",
            "product_type": "hris_integration",
            "id": "hris_200",
            "pricing_type": "by_seat",
            "monthly_price_cents": 200,
            "yearly_price_cents": 2400,
            "quarterly_price_cents": 600,
            "cycle": "month",
            "currency": "USD",
            "quantity": null
          }
        ],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {
        "hris_integration": {
          "id": "hris_200"
        }
      },
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "835"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/836

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "active_products": {}
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "836",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "836"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/837

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "seats": 5,
      "plan_cycle": "year"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "837",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 120,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [
          {
            "stripe_id": "addon_hris_2400_yearly",
            "product_type": "hris_integration",
            "id": "hris_200",
            "pricing_type": "by_seat",
            "monthly_price_cents": 200,
            "yearly_price_cents": 2400,
            "quarterly_price_cents": 600,
            "cycle": "year",
            "currency": "USD",
            "quantity": null
          }
        ],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 5,
      "seats_used": 1,
      "seats_pending": 5,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {
        "hris_integration": {
          "id": "hris_200"
        }
      },
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "837"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/838

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "stripe_token": "tok_u5dg20Gra",
      "seats": 3
    }
  }
}
Responses402
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": 402,
      "title": "Stripe error",
      "detail": "The card was declined.",
      "meta": {},
      "source": {}
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/849

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "stripe_token": "tok_u5dg20Gra"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "seats_below_minimum",
      "title": "Invalid Attribute",
      "detail": "can't be less than 3",
      "meta": {},
      "source": {
        "pointer": "data/attributes/seats"
      }
    },
    {
      "status": "422",
      "code": "legacy_plan_not_allowed",
      "title": "Invalid Attribute",
      "detail": "can't be set to a legacy plan",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/850

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "trial_plan_type": "professional_2026"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "850",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 2,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 15,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "standard",
        "name": "Standard",
        "type": null,
        "monthly_price_cents": 1500,
        "yearly_price_cents": 15000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": true,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "essential_2026",
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": false,
        "cycle_change_error": "plan_discontinued",
        "upgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "standard",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-15 23:59:59",
      "trial_plan_type": "professional_2026",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "850"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/851

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "year",
      "stripe_token": "tok_u5dg20Gra"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "seats_below_minimum",
      "title": "Invalid Attribute",
      "detail": "can't be less than 3",
      "meta": {},
      "source": {
        "pointer": "data/attributes/seats"
      }
    },
    {
      "status": "422",
      "code": "plan_cycle_change_not_allowed_legacy",
      "title": "Invalid Attribute",
      "detail": "can't be changed on legacy plans",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_cycle"
      }
    },
    {
      "status": "422",
      "code": "legacy_plan_not_allowed",
      "title": "Invalid Attribute",
      "detail": "can't be set to a legacy plan",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/852

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "professional_2026"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "852",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 29,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "professional_2026",
        "name": "Professional",
        "type": null,
        "monthly_price_cents": 2900,
        "yearly_price_cents": 30000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [
          "essential_2026"
        ],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          }
        ]
      },
      "plan_type": "professional_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-08 23:59:59",
      "trial_plan_type": "professional_2026",
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "852"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/853

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "trial_plan_type": null
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "853",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 150,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "year",
      "current_plan": {
        "id": "standard",
        "name": "Standard",
        "type": null,
        "monthly_price_cents": 1500,
        "yearly_price_cents": 15000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": true,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "essential_2026",
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": false,
        "cycle_change_error": "plan_discontinued",
        "upgradeables": [
          {
            "id": "essential_2026",
            "name": "Essential",
            "type": null,
            "monthly_price_cents": 1200,
            "yearly_price_cents": 12000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "professional_2026",
              "ultimate_2026"
            ],
            "downgrades": [],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "standard",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": "2019-01-08 23:59:59",
      "trial_plan_type": null,
      "trial_plan_active": true,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "853"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/854

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "year"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_cycle_change_not_allowed_legacy",
      "title": "Invalid Attribute",
      "detail": "can't be changed on legacy plans",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_cycle"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/855

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "premium"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_type_invalid",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/856

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "premium_2025"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_type_invalid",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/857

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "standard"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_type_invalid",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/858

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "ultimate"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_type_invalid",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    },
    {
      "status": "422",
      "code": "plan_type_invalid_gated",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/859

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_type": "standard",
      "plan_cycle": "month"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "plan_type_invalid",
      "title": "Invalid Attribute",
      "detail": "invalid plan type",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_type"
      }
    },
    {
      "status": "422",
      "code": "plan_cycle_change_not_allowed_legacy",
      "title": "Invalid Attribute",
      "detail": "can't be changed on legacy plans",
      "meta": {},
      "source": {
        "pointer": "data/attributes/plan_cycle"
      }
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/860

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "plan_cycle": "month"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "860",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 24,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "premium",
        "name": "Premium",
        "type": null,
        "monthly_price_cents": 2400,
        "yearly_price_cents": 24000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": true,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": false,
        "cycle_change_error": "plan_discontinued",
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "premium",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "860"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a organization subscription
PATCH/api/v2/organization_subscriptions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

organization subscription id

PATCH /api/v2/organization_subscriptions/1/cancel
Requestscancels subscription and tracks planhat activityreturns error and does not track planhat activitycancels subscriptionreturns error

PATCH  /api/v2/organization_subscriptions/841/cancel

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "deactivation_reason_id": 2,
      "deactivation_note": "Why I quit Productive"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "841",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 6,
      "trial_ends_at": null,
      "subscription_started_at": "2019-01-01T12:00:00.000+01:00",
      "subscription_ended_at": null,
      "next_billing_cycle_at": "2023-10-31 11:40:14",
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "841"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/842/cancel

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "deactivation_reason_id": 2,
      "deactivation_note": "Why I quit Productive"
    }
  }
}
Responses503
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": 503,
      "title": "Stripe error",
      "detail": "A temporary problem with Stripe's servers.",
      "meta": {},
      "source": {}
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/862/cancel

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "deactivation_reason_id": 2,
      "deactivation_note": "Why I quit Productive"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "862",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 6,
      "trial_ends_at": null,
      "subscription_started_at": "2019-01-01T12:00:00.000+01:00",
      "subscription_ended_at": null,
      "next_billing_cycle_at": "2015-10-15 12:01:22",
      "grace_period_ends_at": null,
      "plan_price": 24,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "premium",
        "name": "Premium",
        "type": null,
        "monthly_price_cents": 2400,
        "yearly_price_cents": 24000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": true,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": false,
        "cycle_change_error": "plan_discontinued",
        "upgradeables": [
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "premium",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_474RjipEtz2ff7",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "862"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/863/cancel

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "organization_subscriptions",
    "attributes": {
      "deactivation_reason_id": 2,
      "deactivation_note": "Why I quit Productive"
    }
  }
}
Responses503
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": 503,
      "title": "Stripe error",
      "detail": "A temporary problem with Stripe's servers.",
      "meta": {},
      "source": {}
    }
  ]
}

Cancels a organization subscription
PATCH/api/v2/organization_subscriptions/{id}/cancel

URI Parameters
HideShow
id
number (required) Example: 1

organization subscription id

PATCH /api/v2/organization_subscriptions/1/reactivate
Requestsreactivates subscription and tracks planhat activityreturns error and does not track planhat activitydoesn't reactivate subscriptionreturns error

PATCH  /api/v2/organization_subscriptions/843/reactivate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "843",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": 2,
      "trial_ends_at": null,
      "subscription_started_at": "2019-01-01T12:00:00.000+01:00",
      "subscription_ended_at": null,
      "next_billing_cycle_at": "2023-10-31 11:40:14",
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": true
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "843"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/organization_subscriptions/844/reactivate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses503
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": 503,
      "title": "Stripe error",
      "detail": "A temporary problem with Stripe's servers.",
      "meta": {},
      "source": {}
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/864/reactivate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses405
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "405",
      "code": "reactivation_error",
      "title": "Reactivation error",
      "detail": "Can't reactivate subscription on a legacy plan",
      "meta": {},
      "source": {}
    }
  ]
}

PATCH  /api/v2/organization_subscriptions/865/reactivate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses503
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": 503,
      "title": "Stripe error",
      "detail": "A temporary problem with Stripe's servers.",
      "meta": {},
      "source": {}
    }
  ]
}

Reactivates a organization subscription
PATCH/api/v2/organization_subscriptions/{id}/reactivate

URI Parameters
HideShow
id
number (required) Example: 1

organization subscription id

PATCH /api/v2/organization_subscriptions/1/retry_last_payment
Requestsretries last invoice payment

PATCH  /api/v2/organization_subscriptions/845/retry_last_payment

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "845",
    "type": "organization_subscriptions",
    "attributes": {
      "billing_email": null,
      "billing_address": null,
      "subscription_state_id": null,
      "trial_ends_at": null,
      "subscription_started_at": null,
      "subscription_ended_at": null,
      "next_billing_cycle_at": null,
      "grace_period_ends_at": null,
      "plan_price": 12,
      "discount": null,
      "discount_expires_on": null,
      "plan_cycle": "month",
      "current_plan": {
        "id": "essential_2026",
        "name": "Essential",
        "type": null,
        "monthly_price_cents": 1200,
        "yearly_price_cents": 12000,
        "quarterly_price_cents": null,
        "currency": "USD",
        "discontinued": false,
        "tiers": [],
        "annual_tiers": [],
        "quarterly_tiers": [],
        "upgrades": [
          "professional_2026",
          "ultimate_2026"
        ],
        "downgrades": [],
        "gated": false,
        "active_products": [],
        "buyable_products": [],
        "features": {},
        "cycle_change_enabled": true,
        "cycle_change_error": null,
        "upgradeables": [
          {
            "id": "professional_2026",
            "name": "Professional",
            "type": null,
            "monthly_price_cents": 2900,
            "yearly_price_cents": 30000,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [
              "ultimate_2026"
            ],
            "downgrades": [
              "essential_2026"
            ],
            "gated": false,
            "features": {},
            "buyable": true,
            "trialable": false
          },
          {
            "id": "ultimate_2026",
            "name": "Ultimate",
            "type": null,
            "monthly_price_cents": 4000,
            "yearly_price_cents": 39600,
            "quarterly_price_cents": null,
            "currency": "USD",
            "discontinued": false,
            "tiers": [],
            "annual_tiers": [],
            "quarterly_tiers": [],
            "upgrades": [],
            "downgrades": [
              "essential_2026",
              "professional_2026"
            ],
            "gated": true,
            "features": {},
            "buyable": false,
            "trialable": false
          }
        ],
        "downgradeables": []
      },
      "plan_type": "essential_2026",
      "payment_method_id": 1,
      "collection_method_id": 1,
      "seats": 1,
      "seats_used": 1,
      "seats_pending": 1,
      "trial_plan_ends_at": null,
      "trial_plan_type": null,
      "trial_plan_active": false,
      "active_products": {},
      "billing_group_admin": false,
      "billing_group_member": false,
      "billing_group_seats": null,
      "card_brand": null,
      "card_last4": null,
      "card_month": null,
      "card_year": null,
      "contract_date": null,
      "contract_seats": null,
      "contract_min_seats": null,
      "stripe_customer_id": "cus_MfjzMZLrVonbx9",
      "balance": "0.0"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "845"
        }
      },
      "billing_group_owner": {
        "meta": {
          "included": false
        }
      },
      "billing_group_members": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Retry last payment for a organization subscription
PATCH/api/v2/organization_subscriptions/{id}/retry_last_payment

URI Parameters
HideShow
id
number (required) Example: 1

organization subscription id

Generated by aglio on 17 Mar 2026