• 1.0latest114Docs2026-07-13 14:11

  Change detail

  6 changes across 1 operation

  AllBreakingWarningInfo

  • GET/invoice/{invoice_id}/pricing_rules_logs
    • breaking

      removed the required property data/items/ruleId from the response with the 200 status

    • warning

      removed the optional property data/items/ruleName from the response with the 200 status

    • info

      added the optional property data/items/changes/keyName to the response with the 200 status

    • info

      added the optional property data/items/rule to the response with the 200 status

    • info

      added the optional property data/items/type to the response with the 200 status

    • info

      added the optional property data/items/variablesValue to the response with the 200 status

• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#55)1017Docs64baf3a2024-07-11 09:33

  Change detail

  27 changes across 16 operations

  AllBreakingWarningInfo

  • PATCH/invoices/{invoice_id}
    • warning

      added the new ADHOC_ADVANCED enum value to the invoiceType response property for the response status 200

    • warning

      added the new STANDARD_ADVANCED enum value to the invoiceType response property for the response status 200

    • info

      added the new REFUND_INITIATED enum value to the request property status

  • POST/accounts/{account_id}/edit_schedules
    • info

      added the new optional request property edits/items/pricingRulesOverride/items/invoiceTiming

    • info

      added the optional property pricingSchedules/items/pricingRulesOverride/items/invoiceTiming to the response with the 200 status

  • POST/accounts/{account_id}/price_plans
    • info

      added the new optional request property allOf[#/components/schemas/UpdatePricingScheduleRequest]/pricingRulesOverride/items/invoiceTiming

    • info

      added the optional property pricingSchedules/items/pricingRulesOverride/items/invoiceTiming to the response with the 200 status

  View all changes (27)
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#54)53Docs9bab7ca2024-07-11 07:08

  Change detail

  8 changes across 6 operations and 1 model

  AllBreakingWarningInfo

  • POST/license_updates
    • breaking

      the allOf[#/components/schemas/LicenseUpdate]/quantity response's property type changed from integer to number for status 200

    • info

      the quantity request property type was generalized from integer to number

  • POST/authenticate
    • breaking

      removed the media type text/plain for the response with the status 200

  • POST/invoices/{invoice_id}/payments
    • breaking

      api path removed without deprecation

  • PATCH/license_updates/{license_id}
    • breaking

      the allOf[#/components/schemas/LicenseUpdate]/quantity response's property type changed from integer to number for status 200

  • GET/license_updates
    • breaking

      the data/items/allOf[#/components/schemas/LicenseUpdate]/quantity response's property type changed from integer to number for status 200

  • POST/portal/token
    • info

      endpoint added

  • Models
    • info

      removed the schema InvoicePaymentsRequest

• Update openapi.yaml (#51)no API changesDocscf1ff232024-05-27 14:22
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#50)1850Docs16664032024-05-27 14:15

  Change detail

  68 changes across 35 operations

  AllBreakingWarningInfo

  • GET/invoices/{invoice_id}
    • warning

      added the new PROXY_AMOUNT enum value to the revenueInfo/type response property for the response status 200

    • warning

      added the new PROXY_AMOUNT enum value to the usageInfo/items/type response property for the response status 200

    • warning

      added the new USAGE_CYCLE_AMOUNT enum value to the revenueInfo/type response property for the response status 200

    • warning

      added the new USAGE_CYCLE_AMOUNT enum value to the usageInfo/items/type response property for the response status 200

  • PATCH/invoices/{invoice_id}
    • warning

      added the new PROXY_AMOUNT enum value to the revenueInfo/type response property for the response status 200

    • warning

      added the new PROXY_AMOUNT enum value to the usageInfo/items/type response property for the response status 200

    • warning

      added the new USAGE_CYCLE_AMOUNT enum value to the revenueInfo/type response property for the response status 200

  View all changes (68)
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#49)337Docsbe74f512024-05-14 12:11

  Change detail

  13 changes across 8 operations

  AllBreakingWarningInfo

  • POST/events/correction
    • breaking

      the data/items/allOf[#/components/schemas/EventWithStatus]/eventPayload/dimensions/additionalProperties response property's maxLength was increased from 50 to 200 for the response status 200

    • warning

      added the new INGESTION_FAILED_INSUFFICIENT_CREDITS enum value to the data/items/allOf[#/components/schemas/EventWithStatus]/ingestionStatus/status response property for the response status 200

    • info

      the event/dimensions/additionalProperties request property's maxLength was increased from 50 to 200

  • GET/events/{event_id}
    • breaking

      the events/items/allOf[#/components/schemas/EventWithStatus]/eventPayload/dimensions/additionalProperties response property's maxLength was increased from 50 to 200 for the response status 200

    • warning

      added the new INGESTION_FAILED_INSUFFICIENT_CREDITS enum value to the events/items/allOf[#/components/schemas/EventWithStatus]/ingestionStatus/status response property for the response status 200

  • GET/events
    • breaking

      the events/items/eventPayload/dimensions/additionalProperties response property's maxLength was increased from 50 to 200 for the response status 200

    • warning

      added the new INGESTION_FAILED_INSUFFICIENT_CREDITS enum value to the events/items/ingestionStatus/status response property for the response status 200

  View all changes (13)
• Added archive price plan API1Docsc8d39f72024-04-24 01:39
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'2231Docs69000d62024-04-18 11:05
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#42)257Docs2de47eb2024-03-26 05:02
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'32553Docs2e1f6562024-03-18 13:03
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#38)311754Docs87574732024-03-11 16:56
• Updated docsno API changesDocsc657eaf2024-03-01 06:28
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#37)133189539Docs6b208602024-03-01 06:10
• Add list API query params to list accounts APIno API changesDocs51be5fb2024-01-12 10:55
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'1315Docs24f31982024-01-05 13:12
• Doc fixno API changesDocs6f508f72023-12-23 07:47
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#24)463Docsbae1c9f2023-12-22 06:13
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#23)171024Docs63dd0872023-12-21 10:43
• updated payments apis5Docsf1c5f782023-12-08 09:25
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#19)15Docs8836dee2023-12-07 15:44
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#17)13757Docscada1f02023-11-30 12:34
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#16)6925149Docs30244462023-11-03 11:32
• Add notes for Event Correction API (#13)2Docsb86dfe42023-10-25 06:37
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'1482Docs35188512023-10-16 11:59
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'45Docs8238e2c2023-10-09 08:27
• Add examples for update entitlements1Docsb9c04672023-10-06 11:58
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml'49Docs86659fd2023-10-06 07:35
• 🔄 synced local 'openapi.yaml' with remote 'mintlify_output.yml' (#8)614Docs379255d2023-10-06 07:07
• Add 409 conflict response for /entitled API1Docs9202b802023-09-25 16:00
• Updated idempotency key description and few minor changes517677Docscdb0aea2023-09-25 15:51
• Update openapi.yamlno API changesDocs63978c12023-09-17 05:41
• List wallet entries API221276Docs12c3e902023-09-07 16:57
• Added change log and add-ons pagesno API changesDocsfc49bb22023-09-02 14:51
• Initial commit371649571Docsc0694452023-09-02 02:31

Revisions go back to the API's first capture.