> ## Documentation Index > Fetch the complete documentation index at: https://docs.getlago.com/llms.txt > Use this file to discover all available pages before exploring further. # Update subscription entitlements > This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints. ## OpenAPI ````yaml PATCH /subscriptions/{external_id}/entitlements openapi: 3.1.0 info: title: Lago API documentation description: >- Lago API allows your application to push customer information and metrics (events) from your application to the billing application. version: 1.45.2 license: name: AGPLv3 url: https://github.com/getlago/lago-openapi/blob/main/LICENSE contact: email: tech@getlago.com servers: - url: https://api.getlago.com/api/v1 description: US Lago cluster - url: https://api.eu.getlago.com/api/v1 description: EU Lago cluster security: - bearerAuth: [] tags: - name: activity_logs description: Everything about Activity logs externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/audit-logs/activity-logs-object - name: analytics description: Everything about Analytics - name: api_logs description: Everything about API logs externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/audit-logs/api-logs-object - name: billable_metrics description: Everything about Billable metric collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/billable-metrics/object - name: features description: Everything about Feature collection externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/entitlements/features/feature-object - name: entitlements description: Everything about Entitlement collection externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object - name: billing_entities description: Everything about Billing Entities externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/billing-entities/object - name: customers description: Everything about Customer collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/customers/object - name: plans description: Everything about Plan collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/plans/object - name: subscriptions description: Everything about Subscription collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/subscriptions/subscription-object - name: events description: Everything about Event collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/events/event-object - name: organizations description: Everything about Organization collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/organizations/organization-object - name: taxes description: Everything about Tax collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/taxes/tax-object - name: coupons description: Everything about Coupon collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/coupons/coupon-object - name: add_ons description: Everything about Add-on collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/add-ons/add-on-object - name: fees description: Everything about Fees externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object - name: invoices description: Everything about Invoice collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/invoices/invoice-object - name: wallets description: Everything about Wallet collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/wallets/wallet-object - name: credit_notes description: Everything about Credit notes collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/credit-notes/credit-note-object - name: webhooks description: Everything about Webhooks externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key - name: webhook_endpoints description: Everything about Webhook Endpoints externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object - name: payment_receipts description: Everything about Payment receipts externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object - name: payment_requests description: Everything about PaymentRequests externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-requests/payment-request-object - name: payments description: Everything about Payments externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/payments/payment-object - name: payment_methods description: Everything about Payment Methods externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-methods/payment-method-object externalDocs: description: Lago Github url: https://github.com/getlago paths: /subscriptions/{external_id}/entitlements: parameters: - name: external_id in: path description: External ID of the existing subscription required: true schema: type: string example: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba patch: tags: - entitlements summary: Update subscription entitlements description: >- This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints. operationId: updateSubscriptionEntitlements parameters: - $ref: '#/components/parameters/subscription_status' requestBody: description: Subscription entitlements payload content: application/json: schema: $ref: '#/components/schemas/EntitlementUpdateInput' required: true responses: '200': description: Subscription entitlements updated content: application/json: schema: $ref: '#/components/schemas/SubscriptionEntitlements' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/UnprocessableEntity' components: parameters: subscription_status: name: subscription_status in: query description: > Filter by subscription status. When provided, the subscription is looked up with this status instead of the default `active` status. Possible values are `pending`, `active`, `terminated`, or `canceled`. required: false schema: type: string enum: - pending - active - terminated - canceled default: active example: active schemas: EntitlementUpdateInput: type: object required: - entitlements properties: entitlements: type: object additionalProperties: type: object additionalProperties: oneOf: - type: integer - type: boolean - type: string description: >- Privilege values for this feature. All privileges must exist on the feature. example: seats: max: 20 max_admins: 10 root: false sso: provider: okta description: >- Feature entitlements with their privilege values. Each key is a feature code, and the value is an object containing privilege codes with their associated values. SubscriptionEntitlements: type: object required: - entitlements properties: entitlements: type: array items: $ref: '#/components/schemas/SubscriptionEntitlementObject' SubscriptionEntitlementObject: type: object required: - code - name - description - privileges - overrides properties: code: type: string example: seats description: Unique code used to identify the feature. Max 255 characters. name: type: - string - 'null' example: Number of seats description: Name of the feature. Max 255 characters. description: type: - string - 'null' example: Number of users of the account description: Description of the feature. Max 600 characters. privileges: type: array items: $ref: '#/components/schemas/SubscriptionEntitlementPrivilegeObject' example: - code: max name: Maximum value_type: integer config: {} value: 15 plan_value: 10 override_value: 15 - code: max_admins name: Max Admins value_type: integer config: {} value: 5 plan_value: 5 override_value: null - code: root name: Allow root user value_type: boolean config: {} value: true plan_value: true override_value: null - code: provider name: SSO Provider value_type: select value: okta plan_value: google override_value: okta config: select_options: - google - okta description: >- Privileges associated with this feature. Each privilege shows the plan value and any subscription override. overrides: type: object additionalProperties: true example: max: 15 provider: okta ApiErrorBadRequest: type: object required: - status - error properties: status: type: integer format: int32 example: 400 error: type: string example: Bad request ApiErrorUnauthorized: type: object required: - status - error properties: status: type: integer format: int32 example: 401 error: type: string example: Unauthorized ApiErrorNotFound: type: object required: - status - error - code properties: status: type: integer format: int32 example: 404 error: type: string example: Not Found code: type: string example: object_not_found ApiErrorUnprocessableEntity: type: object required: - status - error - code - error_details properties: status: type: integer format: int32 example: 422 error: type: string example: Unprocessable entity code: type: string example: validation_errors error_details: type: object SubscriptionEntitlementPrivilegeObject: allOf: - $ref: '#/components/schemas/FeaturePrivilegeObject' - type: object required: - value - plan_value - override_value properties: value: oneOf: - type: integer description: Value for integer type privileges - type: boolean description: Value for boolean type privileges - type: string description: Value for string or select type privileges example: 10 description: >- Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type. plan_value: oneOf: - type: integer description: Value for integer type privileges - type: boolean description: Value for boolean type privileges - type: string description: Value for string or select type privileges example: 10 description: >- Value assigned to this privilege in the plan. Type depends on the privilege's value_type. override_value: oneOf: - type: integer description: Value for integer type privileges - type: boolean description: Value for boolean type privileges - type: string description: Value for string or select type privileges - type: 'null' description: No override value set example: 10 description: >- Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set. FeaturePrivilegeObject: type: object required: - code - name - value_type - config properties: code: type: string example: max description: Unique code for the privilege. name: type: - string - 'null' example: Maximum description: Display name for the privilege. value_type: type: string enum: - integer - boolean - string - select example: integer description: 'Data type of the privilege value. Default: string' config: type: object properties: select_options: type: array items: type: string example: - google - okta description: Array of string, required only when value_type is `select`. responses: BadRequest: description: Bad Request error content: application/json: schema: $ref: '#/components/schemas/ApiErrorBadRequest' Unauthorized: description: Unauthorized error content: application/json: schema: $ref: '#/components/schemas/ApiErrorUnauthorized' NotFound: description: Not Found error content: application/json: schema: $ref: '#/components/schemas/ApiErrorNotFound' UnprocessableEntity: description: Unprocessable entity error content: application/json: schema: $ref: '#/components/schemas/ApiErrorUnprocessableEntity' securitySchemes: bearerAuth: type: http scheme: bearer ````