9bd20cb2e9
* docs improvements * many changes * prompt changes * add refetch comment * fix: checkout subscription data * cus eligibility fixes * rm cursor thing --------- Co-authored-by: Ayush Rodrigues <joesj2905@gmail.com> Co-authored-by: John Yeo <johnyeocx@gmail.com> Co-authored-by: John Yeo <51376134+johnyeocx@users.noreply.github.com> Co-authored-by: Ayush <74830628+ay-rod@users.noreply.github.com>
314 lines
8.0 KiB
JSON
314 lines
8.0 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "mint",
|
|
"name": "Autumn",
|
|
"colors": {
|
|
"primary": "#8838ff",
|
|
"light": "#8838ff",
|
|
"dark": "#8838ff"
|
|
},
|
|
"appearance": {
|
|
"default": "system",
|
|
"strict": false
|
|
},
|
|
"contextual": {
|
|
"options": ["copy", "cursor", "view"]
|
|
},
|
|
"banner": {
|
|
"content": "You're viewing the docs for Autumn's v2 API. You can find the previous API version [here](https://docs-v1.useautumn.com).",
|
|
"dismissible": true
|
|
},
|
|
"favicon": "/favicon.png",
|
|
"interaction": {
|
|
"drilldown": true
|
|
},
|
|
"navigation": {
|
|
"global": {
|
|
"anchors": [
|
|
{
|
|
"anchor": "Discord",
|
|
"icon": "discord",
|
|
"href": "https://discord.gg/STqxY92zuS"
|
|
},
|
|
{
|
|
"anchor": "GitHub",
|
|
"icon": "github",
|
|
"href": "https://github.com/useautumn/autumn"
|
|
},
|
|
{
|
|
"anchor": "Website",
|
|
"icon": "globe",
|
|
"href": "https://useautumn.com"
|
|
}
|
|
]
|
|
},
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"icon": "folder-open",
|
|
"groups": [
|
|
{
|
|
"group": " ",
|
|
"pages": [
|
|
"welcome",
|
|
{
|
|
"group": "Concepts",
|
|
"pages": [
|
|
"documentation/concepts/overview",
|
|
"documentation/concepts/plans",
|
|
"documentation/concepts/features",
|
|
"documentation/concepts/plan-items",
|
|
"documentation/concepts/subscriptions",
|
|
"documentation/concepts/balances",
|
|
"documentation/concepts/stripe"
|
|
]
|
|
},
|
|
"documentation/getting-started/migration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"documentation/getting-started/setup",
|
|
"documentation/getting-started/gating",
|
|
"documentation/getting-started/display-billing"
|
|
]
|
|
},
|
|
{
|
|
"group": "Configure Pricing",
|
|
"pages": [
|
|
"documentation/modelling-pricing/recurring",
|
|
"documentation/modelling-pricing/one-off-purchases",
|
|
"documentation/modelling-pricing/free-plans",
|
|
"documentation/modelling-pricing/credit-systems",
|
|
"documentation/modelling-pricing/prepaid-pricing",
|
|
"documentation/modelling-pricing/usage-based-pricing",
|
|
"documentation/modelling-pricing/per-unit-pricing",
|
|
"documentation/modelling-pricing/rollovers",
|
|
"documentation/modelling-pricing/proration",
|
|
"documentation/modelling-pricing/trials",
|
|
"documentation/modelling-pricing/auto-top-ups",
|
|
"documentation/modelling-pricing/spend-limits",
|
|
"documentation/modelling-pricing/add-ons",
|
|
"documentation/modelling-pricing/graduated-pricing",
|
|
"documentation/modelling-pricing/volume-based-tiers",
|
|
"documentation/modelling-pricing/sub-entity-balances",
|
|
"documentation/modelling-pricing/sub-entity-plans",
|
|
"documentation/modelling-pricing/rewards"
|
|
]
|
|
},
|
|
{
|
|
"group": "Billing & Subscriptions",
|
|
"pages": [
|
|
"documentation/customers/payment-flow",
|
|
"documentation/customers/subscription-lifecycle",
|
|
"documentation/customers/updating-subscriptions",
|
|
"documentation/customers/custom-plans",
|
|
"documentation/customers/versioning",
|
|
"documentation/customers/edge-cases"
|
|
]
|
|
},
|
|
{
|
|
"group": "Customers",
|
|
"pages": [
|
|
"documentation/customers/creating-customers",
|
|
"documentation/customers/managing-customers",
|
|
"documentation/customers/check",
|
|
"documentation/customers/tracking-usage",
|
|
"documentation/customers/balance-locking",
|
|
"documentation/customers/managing-balances",
|
|
"documentation/customers/feature-entities"
|
|
]
|
|
},
|
|
{
|
|
"group": "Additional Resources",
|
|
"pages": [
|
|
"documentation/webhooks",
|
|
"documentation/external-providers/convex",
|
|
"documentation/external-providers/revenuecat",
|
|
"documentation/external-providers/vercel-marketplace"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Examples",
|
|
"icon": "graduation-cap",
|
|
"pages": [
|
|
"examples/monetary-credits",
|
|
"examples/prepaid",
|
|
"examples/per-seat",
|
|
"examples/pay-as-you-go-overages",
|
|
"examples/entity-balances",
|
|
"examples/trial-card-required",
|
|
"examples/trial-card-not-required"
|
|
]
|
|
},
|
|
{
|
|
"tab": "React",
|
|
"icon": "react",
|
|
"groups": [
|
|
{
|
|
"group": "React Hooks",
|
|
"pages": [
|
|
"react/hooks/introduction",
|
|
"react/hooks/autumn-provider",
|
|
"react/hooks/autumn-handler",
|
|
"react/hooks/useCustomer",
|
|
"react/hooks/useEntity",
|
|
"react/hooks/useListEvents",
|
|
"react/hooks/useAggregateEvents",
|
|
"react/hooks/useListPlans",
|
|
"react/hooks/useReferrals"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "CLI",
|
|
"icon": "square-terminal",
|
|
"pages": ["cli/getting-started", "cli/config", "cli/commands"]
|
|
},
|
|
{
|
|
"tab": "API Reference",
|
|
"icon": "display-code",
|
|
"groups": [
|
|
{
|
|
"group": "Billing",
|
|
"pages": [
|
|
"api-reference/billing/attach",
|
|
"api-reference/billing/billingUpdate",
|
|
"api-reference/billing/previewAttach",
|
|
"api-reference/billing/previewUpdate",
|
|
"api-reference/billing/openCustomerPortal",
|
|
"api-reference/billing/setupPayment",
|
|
"api-reference/billing/previewMultiAttach",
|
|
"api-reference/billing/multiAttach"
|
|
]
|
|
},
|
|
{
|
|
"group": "Balances",
|
|
"pages": [
|
|
"api-reference/core/check",
|
|
"api-reference/core/track",
|
|
"api-reference/balances/createBalance",
|
|
"api-reference/balances/updateBalance",
|
|
"api-reference/balances/deleteBalance",
|
|
"api-reference/balances/finalizeLock"
|
|
]
|
|
},
|
|
{
|
|
"group": "Customers",
|
|
"pages": [
|
|
"api-reference/customers/getOrCreateCustomer",
|
|
"api-reference/customers/listCustomers",
|
|
"api-reference/customers/updateCustomer",
|
|
"api-reference/customers/deleteCustomer"
|
|
]
|
|
},
|
|
{
|
|
"group": "Events",
|
|
"pages": [
|
|
"api-reference/events/listEvents",
|
|
"api-reference/events/aggregateEvents"
|
|
]
|
|
},
|
|
{
|
|
"group": "Entities",
|
|
"pages": [
|
|
"api-reference/entities/getEntity",
|
|
"api-reference/entities/createEntity",
|
|
"api-reference/entities/updateEntity",
|
|
"api-reference/entities/deleteEntity"
|
|
]
|
|
},
|
|
{
|
|
"group": "Plans",
|
|
"pages": [
|
|
"api-reference/plans/getPlan",
|
|
"api-reference/plans/listPlans",
|
|
"api-reference/plans/createPlan",
|
|
"api-reference/plans/updatePlan",
|
|
"api-reference/plans/deletePlan"
|
|
]
|
|
},
|
|
{
|
|
"group": "Features",
|
|
"pages": [
|
|
"api-reference/features/getFeature",
|
|
"api-reference/features/listFeatures",
|
|
"api-reference/features/createFeature",
|
|
"api-reference/features/updateFeature",
|
|
"api-reference/features/deleteFeature"
|
|
]
|
|
},
|
|
|
|
{
|
|
"group": "Referrals",
|
|
"pages": [
|
|
"api-reference/referrals/createReferralCode",
|
|
"api-reference/referrals/redeemReferralCode"
|
|
]
|
|
},
|
|
{
|
|
"group": "Platform (Beta)",
|
|
"pages": [
|
|
"api-reference/platform/overview",
|
|
"api-reference/platform/create-organization",
|
|
"api-reference/platform/oauth-url",
|
|
"api-reference/platform/update-stripe",
|
|
"api-reference/platform/list-users",
|
|
"api-reference/platform/list-orgs"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Changelog",
|
|
"icon": "list-ol",
|
|
"pages": ["changelog/changelog"]
|
|
}
|
|
]
|
|
},
|
|
"logo": {
|
|
"light": "/assets/logo/autumn-dark.png",
|
|
"dark": "/assets/logo/autumn-light.png"
|
|
},
|
|
"api": {
|
|
"playground": {
|
|
"display": "interactive"
|
|
},
|
|
"examples": {
|
|
"languages": ["typescript", "python", "bash"]
|
|
}
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"light": "#FAFAFA",
|
|
"dark": "#121212"
|
|
}
|
|
},
|
|
"navbar": {
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Dashboard",
|
|
"href": "https://app.useautumn.com"
|
|
}
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/autumnpricing",
|
|
"github": "https://github.com/useautumn",
|
|
"linkedin": "https://linkedin.com/company/useautumn"
|
|
}
|
|
},
|
|
"fonts": {
|
|
"heading": {
|
|
"family": "Inter"
|
|
},
|
|
"body": {
|
|
"family": "Inter"
|
|
}
|
|
}
|
|
}
|