> ## Documentation Index > Fetch the complete documentation index at: https://commet.co/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update offer > Replace reusable offer terms. Existing applications keep their immutable accepted terms. Replace reusable offer terms. Existing applications keep their immutable accepted terms. ## OpenAPI ````yaml /openapi/es/rest/2026-08-27.json patch /offers/{id} openapi: 3.1.0 info: title: Commet API version: '2026-08-27' description: Billing and payments API for SaaS and AI products. servers: - url: https://commet.co/api/v1 security: - ApiKeyAuth: [] tags: - name: Test Clock description: >- Simulate the passage of time in sandbox to test billing flows. Mirrors Stripe test clocks: forward-only and sandbox-only. - name: Customers - name: Subscriptions - name: Plans - name: Markets description: >- Reusable country groups for market-specific prices and selectable price variants. - name: Offers - name: Promo Codes - name: Features - name: Usage - name: Seats - name: Quota - name: Add-ons - name: Portal - name: Credit Packs - name: Plan Groups - name: Invoices - name: Payments description: >- One-time payments with no subscription or plan. Charge a customer's saved payment method off-session, or create a payment link the customer opens to pay. Tax, invoice, and receipt are handled automatically. - name: Transactions - name: Webhooks - name: API Keys - name: Payouts description: >- Withdraw available balance to your bank and manage the payout account (verification + destination bank accounts). - name: Provisioning description: >- Take ownership of an organization an agent provisioned headlessly. The agent holds the API keys from the start; a human claims the account through a claim link. paths: /offers/{id}: patch: tags: - Offers summary: Update offer description: >- Replace reusable offer terms. Existing applications keep their immutable accepted terms. operationId: update-offer parameters: - name: Idempotency-Key in: header required: false description: >- Unique key used to safely retry this write for 24 hours without applying it twice. schema: type: string minLength: 1 maxLength: 200 - name: id in: path required: true schema: type: string - name: Commet-Version in: header required: false description: >- API version used by this reference. Send this header to select this contract explicitly. schema: type: string default: '2026-08-27' example: '2026-08-27' requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 200 phases: minItems: 1 maxItems: 10 type: array items: oneOf: - type: object properties: type: type: string const: free_trial durationDays: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - type - durationDays - type: object properties: type: type: string const: percentage durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' percentage: type: integer minimum: 1 maximum: 9999 description: Discount in basis points. 5000 means 50%. required: - type - durationCycles - percentage - type: object properties: type: type: string const: amount_off durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' amounts: minItems: 1 type: array items: type: object properties: currency: type: string pattern: ^[A-Za-z]{3}$ amount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Amount in the currency's minor unit (for example, cents for USD). required: - currency - amount required: - type - durationCycles - amounts - type: object properties: type: type: string const: fixed_price durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' prices: minItems: 1 type: array items: type: object properties: currency: type: string pattern: ^[A-Za-z]{3}$ amount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Amount in the currency's minor unit (for example, cents for USD). required: - currency - amount required: - type - durationCycles - prices metadata: default: {} type: object propertyNames: type: string additionalProperties: {} startsAt: default: null anyOf: - type: string format: date-time - type: 'null' endsAt: default: null anyOf: - type: string format: date-time - type: 'null' active: default: true type: boolean required: - name - phases responses: '200': description: Success headers: X-Request-Id: $ref: '#/components/headers/RequestId' RateLimit-Limit: description: Maximum number of requests allowed in the current window. schema: type: string RateLimit-Remaining: description: Requests remaining in the current window. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Offer' example: id: offer_1a2b3c4d name: Launch discount phases: - type: percentage durationCycles: 3 durationInterval: monthly percentage: 20 metadata: {} startsAt: null endsAt: null active: true createdAt: '2026-09-07T12:00:00.000Z' updatedAt: '2026-09-07T12:00:00.000Z' object: offer livemode: false '400': description: Bad request headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: validation_error code: validation_error message: The request contains an invalid parameter. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md '401': description: Unauthorized headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: unauthorized message: A valid API key is required. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md '403': description: Forbidden headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: forbidden message: You do not have permission to perform this operation. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md '404': description: Not found headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: not_found_error code: not_found message: The requested resource was not found. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md '409': description: Conflict headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: conflict_error code: idempotency_in_progress message: >- A request with this idempotency key is still being processed. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md '429': description: Too many requests headers: X-Request-Id: $ref: '#/components/headers/RequestId' RateLimit-Limit: description: Maximum number of requests allowed in the current window. schema: type: string RateLimit-Remaining: description: Requests remaining in the current window. schema: type: string RateLimit-Reset: description: Seconds until the rate limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: rate_limit_error code: rate_limited message: >- Too many requests. Retry after the interval specified in the Retry-After header. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md '500': description: Internal server error headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: internal_error code: internal_error message: An unexpected error occurred while processing the request. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md '503': description: Service unavailable headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: internal_error code: idempotency_unavailable message: >- Idempotency storage is temporarily unavailable. Retry with the same idempotency key. doc_url: >- https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md x-codeSamples: - lang: typescript label: TypeScript source: |- import { Commet } from "@commet/node"; const commet = new Commet({ apiKey: "ck_xxx" }); const offer = await commet.offers.update({ id: "ofr_xxx", name: "example", phases: [ { type: "free_trial", durationDays: 30, }, ], }); - lang: python label: Python source: |- from commet import Commet commet = Commet("ck_xxx") offer = commet.offers.update( "ofr_xxx", name="example", phases=[{"type": "free_trial", "duration_days": 30}], ) - lang: go label: Go source: "client, err := commet.New(\"ck_xxx\")\nif err != nil {\n\tlog.Fatal(err)\n}\nctx := context.Background()\n\noffer, err := client.Offers.Update(ctx, \"ofr_xxx\", &commet.UpdateOfferParams{\n\tName: \"example\",\n\tPhases: []commet.UpdateOfferParamsPhasesItem{{Value: commet.UpdateOfferParamsPhasesItemVariant1{\n\t\tType: \"free_trial\",\n\t\tDurationDays: 30,\n\t}}},\n})\nif err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import co.commet.Commet; import co.commet.models.UpdateOfferParamsPhasesItemVariant1; import co.commet.params.UpdateOfferParams; import java.util.List; var commet = Commet.builder().apiKey("ck_xxx").build(); var offer = commet.offers().update( "ofr_xxx", UpdateOfferParams.builder("example", List.of(new UpdateOfferParamsPhasesItemVariant1("free_trial", 30L))).build() ); - lang: php label: PHP source: |- use Commet\Commet; $commet = new Commet('ck_xxx'); $offer = $commet->offers->update( id: 'ofr_xxx', name: 'example', phases: [['type' => 'free_trial', 'duration_days' => 30]], ); components: headers: RequestId: description: >- Server-generated identifier that correlates this response with Platform logs. schema: type: string format: uuid schemas: Offer: type: object properties: id: type: string name: type: string phases: type: array items: oneOf: - type: object properties: type: type: string const: free_trial durationDays: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - type - durationDays additionalProperties: false - type: object properties: type: type: string const: percentage durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' percentage: type: integer minimum: 1 maximum: 9999 description: Discount in basis points. 5000 means 50%. required: - type - durationCycles - durationInterval - percentage additionalProperties: false - type: object properties: type: type: string const: amount_off durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' amounts: minItems: 1 type: array items: type: object properties: currency: type: string pattern: ^[A-Za-z]{3}$ amount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Amount in the currency's minor unit (for example, cents for USD). required: - currency - amount additionalProperties: false required: - type - durationCycles - durationInterval - amounts additionalProperties: false - type: object properties: type: type: string const: fixed_price durationCycles: anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' durationInterval: default: null description: >- Unit the phase duration is counted in. Only a fixed-price phase may set it, because its amount is declared rather than derived from the plan. Defaults to the plan's own billing interval. anyOf: - type: string enum: - weekly - monthly - quarterly - yearly - type: 'null' prices: minItems: 1 type: array items: type: object properties: currency: type: string pattern: ^[A-Za-z]{3}$ amount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Amount in the currency's minor unit (for example, cents for USD). required: - currency - amount additionalProperties: false required: - type - durationCycles - durationInterval - prices additionalProperties: false metadata: type: object propertyNames: type: string additionalProperties: {} startsAt: anyOf: - type: string format: date-time - type: 'null' endsAt: anyOf: - type: string format: date-time - type: 'null' active: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time object: type: string const: offer livemode: type: boolean required: - id - name - phases - metadata - startsAt - endsAt - active - createdAt - updatedAt - object - livemode additionalProperties: false ErrorResponse: type: object properties: error: type: object properties: type: type: string code: type: string message: type: string param: type: string details: {} doc_url: type: string required: - type - code - message - doc_url additionalProperties: false required: - error additionalProperties: false securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ```` ## Related topics - [Offers](/docs/es/offers.md) - [Update plan price](/docs/es/api-reference/plans/update-plan-price.md) - [Update subscription pause](/docs/es/api-reference/subscriptions/update-subscription-pause.md) - [Update plan](/docs/es/api-reference/plans/update-plan.md) - [offer_invalid](/docs/es/api-reference/errors/offer_invalid.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.