Skip to content

Align SDK docs with OpenAPI spec#2

Closed
sandervanhooft wants to merge 1 commit intomainfrom
fix/align-docs-with-openapi-spec
Closed

Align SDK docs with OpenAPI spec#2
sandervanhooft wants to merge 1 commit intomainfrom
fix/align-docs-with-openapi-spec

Conversation

@sandervanhooft
Copy link
Member

Fixes status enums and properties across all SDK documentation to match the authoritative OpenAPI spec from vatlify.

Changes:

  • Orders: Remove invalid refunded status (valid: pending, paid, failed)
  • Subscriptions: Fix statuses (active, created, trial, on_grace_period, paused)
  • Refunds: Fix succeeded to completed, add canceled status
  • Chargebacks: Remove non-existent status field, align properties with spec (uses amount object, reason, originalOrderId)
  • Subscription Plans: Replace active bool with status enum (approved, draft, archived)
  • One-Off Products: Replace active bool with status enum (approved, draft, archived)
  • Webhooks: Fix refund.succeeded to refund.completed

- Orders: remove invalid 'refunded' status (valid: pending, paid, failed)
- Subscriptions: fix statuses to match spec (active, created, trial, on_grace_period, paused)
- Refunds: fix 'succeeded' to 'completed', add 'canceled' status
- Chargebacks: remove non-existent status field, align properties with spec
- Subscription Plans: replace 'active' bool with status enum (approved, draft, archived)
- One-Off Products: replace 'active' bool with status enum (approved, draft, archived)
- Webhooks: fix refund.succeeded to refund.completed
@sandervanhooft
Copy link
Member Author

Superseded by #3 which includes these doc changes plus the PHP code alignment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant