@whop/sdk 0.0.26 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +78 -0
- package/client.d.mts +10 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -9
- package/client.d.ts.map +1 -1
- package/client.js +16 -2
- package/client.js.map +1 -1
- package/client.mjs +16 -2
- package/client.mjs.map +1 -1
- package/package.json +3 -3
- package/resources/access-tokens.d.mts +34 -54
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +34 -54
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +6 -8
- package/resources/access-tokens.js.map +1 -1
- package/resources/access-tokens.mjs +6 -8
- package/resources/access-tokens.mjs.map +1 -1
- package/resources/account-links.d.mts +15 -13
- package/resources/account-links.d.mts.map +1 -1
- package/resources/account-links.d.ts +15 -13
- package/resources/account-links.d.ts.map +1 -1
- package/resources/account-links.js +2 -3
- package/resources/account-links.js.map +1 -1
- package/resources/account-links.mjs +2 -3
- package/resources/account-links.mjs.map +1 -1
- package/resources/ai-chats.d.mts +70 -30
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +70 -30
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +6 -6
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +6 -6
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/app-builds.d.mts +37 -35
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +37 -35
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +7 -4
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +7 -4
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +86 -60
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +86 -60
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +7 -4
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +7 -4
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +38 -32
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +38 -32
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +3 -2
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +3 -2
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/chat-channels.d.mts +28 -20
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +28 -20
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +5 -3
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +5 -3
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +75 -58
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +75 -58
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +3 -2
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +3 -2
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +88 -56
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +88 -56
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +9 -7
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +9 -7
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +90 -67
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +90 -67
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +6 -3
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +6 -3
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/course-chapters.d.mts +27 -22
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +27 -22
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +5 -5
- package/resources/course-chapters.mjs +5 -5
- package/resources/course-lesson-interactions.d.mts +7 -6
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +7 -6
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +3 -2
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +3 -2
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +141 -99
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +141 -99
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +12 -8
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +12 -8
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +44 -35
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +44 -35
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +3 -2
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +3 -2
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +140 -99
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +140 -99
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +9 -5
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +9 -5
- package/resources/courses.mjs.map +1 -1
- package/resources/disputes.d.mts +176 -120
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +176 -120
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +4 -2
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +4 -2
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +29 -16
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +29 -16
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +9 -5
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +9 -5
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +30 -21
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +30 -21
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +9 -5
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +9 -5
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +35 -27
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +35 -27
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -4
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -4
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +58 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +58 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -5
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -5
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +38 -27
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +38 -27
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +6 -3
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +6 -3
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +23 -19
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +23 -19
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +3 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +3 -2
- package/resources/files.mjs.map +1 -1
- package/resources/forum-posts.d.mts +68 -45
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +68 -45
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +8 -4
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +8 -4
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +21 -13
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +21 -13
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +5 -3
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +5 -3
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +136 -100
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +136 -100
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +76 -54
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +76 -54
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +6 -4
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +6 -4
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +19 -15
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +19 -15
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/ledger-accounts.js +1 -1
- package/resources/ledger-accounts.mjs +1 -1
- package/resources/members.d.mts +27 -28
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +27 -28
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +3 -2
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +3 -2
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +85 -62
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +85 -62
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +12 -8
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +12 -8
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +53 -35
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +53 -35
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +9 -5
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +9 -5
- package/resources/messages.mjs.map +1 -1
- package/resources/notifications.d.mts +33 -25
- package/resources/notifications.d.mts.map +1 -1
- package/resources/notifications.d.ts +33 -25
- package/resources/notifications.d.ts.map +1 -1
- package/resources/notifications.js +2 -1
- package/resources/notifications.js.map +1 -1
- package/resources/notifications.mjs +2 -1
- package/resources/notifications.mjs.map +1 -1
- package/resources/payment-methods.d.mts +212 -114
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +212 -114
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +5 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +5 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +96 -56
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +96 -56
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +23 -10
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +23 -10
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-methods.d.mts +50 -35
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +50 -35
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +3 -2
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +3 -2
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +136 -95
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +136 -95
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +9 -5
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +9 -5
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +80 -67
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +80 -67
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +7 -5
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +7 -5
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +60 -40
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +60 -40
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +7 -4
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +7 -4
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -19
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -19
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +7 -4
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +7 -4
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +57 -39
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +57 -39
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +3 -2
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +3 -2
- package/resources/refunds.mjs.map +1 -1
- package/resources/reviews.d.mts +76 -60
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +76 -60
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +3 -2
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +3 -2
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +77 -61
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +77 -61
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +4 -10
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +4 -10
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +854 -509
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +854 -509
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +30 -21
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +30 -21
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +5 -3
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +5 -3
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +28 -20
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +28 -20
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +5 -4
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +5 -4
- package/resources/support-channels.mjs.map +1 -1
- package/resources/topups.d.mts +13 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +13 -9
- package/resources/topups.d.ts.map +1 -1
- package/resources/topups.js +2 -1
- package/resources/topups.js.map +1 -1
- package/resources/topups.mjs +2 -1
- package/resources/topups.mjs.map +1 -1
- package/resources/transfers.d.mts +37 -28
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +37 -28
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +5 -3
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +5 -3
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +60 -18
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +60 -18
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +13 -2
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +13 -2
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +7 -5
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +7 -5
- package/resources/verifications.d.ts.map +1 -1
- package/resources/verifications.js +1 -1
- package/resources/verifications.mjs +1 -1
- package/resources/webhooks.d.mts +188 -133
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +188 -133
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -2
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +3 -2
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +60 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +60 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +3 -2
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +3 -2
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +33 -11
- package/src/resources/access-tokens.ts +37 -59
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +76 -30
- package/src/resources/app-builds.ts +37 -35
- package/src/resources/apps.ts +89 -60
- package/src/resources/authorized-users.ts +38 -32
- package/src/resources/chat-channels.ts +28 -20
- package/src/resources/checkout-configurations.ts +76 -58
- package/src/resources/companies.ts +94 -57
- package/src/resources/company-token-transactions.ts +91 -68
- package/src/resources/course-chapters.ts +27 -22
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +141 -99
- package/src/resources/course-students.ts +44 -35
- package/src/resources/courses.ts +140 -99
- package/src/resources/disputes.ts +176 -120
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +35 -27
- package/src/resources/experiences.ts +58 -49
- package/src/resources/fee-markups.ts +38 -27
- package/src/resources/files.ts +23 -19
- package/src/resources/forum-posts.ts +69 -45
- package/src/resources/forums.ts +21 -13
- package/src/resources/index.ts +4 -2
- package/src/resources/invoices.ts +140 -100
- package/src/resources/leads.ts +76 -54
- package/src/resources/ledger-accounts.ts +19 -15
- package/src/resources/members.ts +27 -28
- package/src/resources/memberships.ts +86 -62
- package/src/resources/messages.ts +53 -35
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +103 -55
- package/src/resources/payout-methods.ts +50 -35
- package/src/resources/plans.ts +136 -95
- package/src/resources/products.ts +219 -70
- package/src/resources/promo-codes.ts +60 -40
- package/src/resources/reactions.ts +25 -19
- package/src/resources/refunds.ts +59 -39
- package/src/resources/reviews.ts +76 -60
- package/src/resources/setup-intents.ts +77 -61
- package/src/resources/shared.ts +2797 -508
- package/src/resources/shipments.ts +30 -21
- package/src/resources/support-channels.ts +28 -20
- package/src/resources/topups.ts +13 -9
- package/src/resources/transfers.ts +37 -28
- package/src/resources/users.ts +72 -18
- package/src/resources/verifications.ts +7 -5
- package/src/resources/webhooks.ts +188 -133
- package/src/resources/withdrawals.ts +60 -46
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/invoices.d.mts
CHANGED
|
@@ -6,7 +6,8 @@ import { type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
|
6
6
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
7
7
|
export declare class Invoices extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Create an invoice for a customer. The invoice can be charged automatically using
|
|
10
|
+
* a stored payment method, or sent to the customer for manual payment.
|
|
10
11
|
*
|
|
11
12
|
* Required permissions:
|
|
12
13
|
*
|
|
@@ -27,7 +28,7 @@ export declare class Invoices extends APIResource {
|
|
|
27
28
|
*/
|
|
28
29
|
create(body: InvoiceCreateParams, options?: RequestOptions): APIPromise<Shared.Invoice>;
|
|
29
30
|
/**
|
|
30
|
-
* Retrieves
|
|
31
|
+
* Retrieves the details of an existing invoice.
|
|
31
32
|
*
|
|
32
33
|
* Required permissions:
|
|
33
34
|
*
|
|
@@ -36,7 +37,8 @@ export declare class Invoices extends APIResource {
|
|
|
36
37
|
*/
|
|
37
38
|
retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Invoice>;
|
|
38
39
|
/**
|
|
39
|
-
*
|
|
40
|
+
* Returns a paginated list of invoices for a company, with optional filtering by
|
|
41
|
+
* product, status, collection method, and creation date.
|
|
40
42
|
*
|
|
41
43
|
* Required permissions:
|
|
42
44
|
*
|
|
@@ -45,7 +47,8 @@ export declare class Invoices extends APIResource {
|
|
|
45
47
|
*/
|
|
46
48
|
list(query: InvoiceListParams, options?: RequestOptions): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem>;
|
|
47
49
|
/**
|
|
48
|
-
* Void an invoice
|
|
50
|
+
* Void an open invoice so it can no longer be paid. Voiding is permanent and
|
|
51
|
+
* cannot be undone.
|
|
49
52
|
*
|
|
50
53
|
* Required permissions:
|
|
51
54
|
*
|
|
@@ -61,46 +64,51 @@ export type InvoiceCreateParams = InvoiceCreateParams.CreateInvoiceInputWithProd
|
|
|
61
64
|
export declare namespace InvoiceCreateParams {
|
|
62
65
|
interface CreateInvoiceInputWithProductAndMemberID {
|
|
63
66
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
67
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
68
|
+
* payment method, or send_invoice to email the customer.
|
|
66
69
|
*/
|
|
67
70
|
collection_method: Shared.CollectionMethod;
|
|
68
71
|
/**
|
|
69
|
-
* The company
|
|
72
|
+
* The unique identifier of the company to create this invoice for.
|
|
70
73
|
*/
|
|
71
74
|
company_id: string;
|
|
72
75
|
/**
|
|
73
|
-
* The date the invoice
|
|
76
|
+
* The date by which the invoice must be paid.
|
|
74
77
|
*/
|
|
75
78
|
due_date: string;
|
|
76
79
|
/**
|
|
77
|
-
* The member
|
|
78
|
-
*
|
|
79
|
-
* an email_address and customer_name.
|
|
80
|
+
* The unique identifier of an existing member to create this invoice for. If not
|
|
81
|
+
* provided, you must supply an email_address and customer_name.
|
|
80
82
|
*/
|
|
81
83
|
member_id: string;
|
|
82
84
|
/**
|
|
83
|
-
* The
|
|
85
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
86
|
+
* invoice.
|
|
84
87
|
*/
|
|
85
88
|
plan: CreateInvoiceInputWithProductAndMemberID.Plan;
|
|
86
89
|
/**
|
|
87
|
-
* The properties of the product to create for this invoice.
|
|
88
|
-
*
|
|
90
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
91
|
+
* a new product inline.
|
|
89
92
|
*/
|
|
90
93
|
product: CreateInvoiceInputWithProductAndMemberID.Product;
|
|
91
94
|
/**
|
|
92
|
-
*
|
|
95
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
96
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
97
|
+
* charge will be processed immediately.
|
|
98
|
+
*/
|
|
99
|
+
automatically_finalizes_at?: string | null;
|
|
100
|
+
/**
|
|
101
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
93
102
|
*/
|
|
94
103
|
charge_buyer_fee?: boolean | null;
|
|
95
104
|
/**
|
|
96
|
-
* The name of the customer
|
|
97
|
-
*
|
|
98
|
-
* company yet.
|
|
105
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
106
|
+
* is not yet a member of the company.
|
|
99
107
|
*/
|
|
100
108
|
customer_name?: string | null;
|
|
101
109
|
/**
|
|
102
|
-
* The
|
|
103
|
-
*
|
|
110
|
+
* The unique identifier of the payment method to charge. Required when
|
|
111
|
+
* collection_method is charge_automatically.
|
|
104
112
|
*/
|
|
105
113
|
payment_method_id?: string | null;
|
|
106
114
|
/**
|
|
@@ -111,11 +119,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
111
119
|
}
|
|
112
120
|
namespace CreateInvoiceInputWithProductAndMemberID {
|
|
113
121
|
/**
|
|
114
|
-
* The
|
|
122
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
123
|
+
* invoice.
|
|
115
124
|
*/
|
|
116
125
|
interface Plan {
|
|
117
126
|
/**
|
|
118
|
-
* The interval at which the plan charges (renewal plans).
|
|
127
|
+
* The interval in days at which the plan charges (renewal plans).
|
|
119
128
|
*/
|
|
120
129
|
billing_period?: number | null;
|
|
121
130
|
/**
|
|
@@ -127,13 +136,14 @@ export declare namespace InvoiceCreateParams {
|
|
|
127
136
|
*/
|
|
128
137
|
description?: string | null;
|
|
129
138
|
/**
|
|
130
|
-
* The
|
|
139
|
+
* The number of days until the membership expires and revokes access (expiration
|
|
140
|
+
* plans). For example, 365 for a one-year access period.
|
|
131
141
|
*/
|
|
132
142
|
expiration_days?: number | null;
|
|
133
143
|
/**
|
|
134
144
|
* An additional amount charged upon first purchase. Use only if a one time payment
|
|
135
145
|
* OR you want to charge an additional amount on top of the renewal price. Provided
|
|
136
|
-
* as a number in
|
|
146
|
+
* as a number in the specified currency. Eg: 10.43 for $10.43
|
|
137
147
|
*/
|
|
138
148
|
initial_price?: number | null;
|
|
139
149
|
/**
|
|
@@ -150,7 +160,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
150
160
|
release_method?: Shared.ReleaseMethod | null;
|
|
151
161
|
/**
|
|
152
162
|
* The amount the customer is charged every billing period. Use only if a recurring
|
|
153
|
-
* payment. Provided as a number in
|
|
163
|
+
* payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
|
|
154
164
|
*/
|
|
155
165
|
renewal_price?: number | null;
|
|
156
166
|
/**
|
|
@@ -162,7 +172,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
162
172
|
*/
|
|
163
173
|
trial_period_days?: number | null;
|
|
164
174
|
/**
|
|
165
|
-
*
|
|
175
|
+
* When true, the plan has unlimited stock (stock field is ignored). When false,
|
|
176
|
+
* purchases are limited by the stock field.
|
|
166
177
|
*/
|
|
167
178
|
unlimited_stock?: boolean | null;
|
|
168
179
|
/**
|
|
@@ -199,8 +210,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
199
210
|
}
|
|
200
211
|
}
|
|
201
212
|
/**
|
|
202
|
-
* The properties of the product to create for this invoice.
|
|
203
|
-
*
|
|
213
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
214
|
+
* a new product inline.
|
|
204
215
|
*/
|
|
205
216
|
interface Product {
|
|
206
217
|
/**
|
|
@@ -215,45 +226,51 @@ export declare namespace InvoiceCreateParams {
|
|
|
215
226
|
}
|
|
216
227
|
interface CreateInvoiceInputWithProductAndEmailAddress {
|
|
217
228
|
/**
|
|
218
|
-
*
|
|
219
|
-
*
|
|
229
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
230
|
+
* payment method, or send_invoice to email the customer.
|
|
220
231
|
*/
|
|
221
232
|
collection_method: Shared.CollectionMethod;
|
|
222
233
|
/**
|
|
223
|
-
* The company
|
|
234
|
+
* The unique identifier of the company to create this invoice for.
|
|
224
235
|
*/
|
|
225
236
|
company_id: string;
|
|
226
237
|
/**
|
|
227
|
-
* The date the invoice
|
|
238
|
+
* The date by which the invoice must be paid.
|
|
228
239
|
*/
|
|
229
240
|
due_date: string;
|
|
230
241
|
/**
|
|
231
|
-
* The email address
|
|
232
|
-
*
|
|
242
|
+
* The email address of the customer. Required when creating an invoice for a
|
|
243
|
+
* customer who is not yet a member of the company.
|
|
233
244
|
*/
|
|
234
245
|
email_address: string;
|
|
235
246
|
/**
|
|
236
|
-
* The
|
|
247
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
248
|
+
* invoice.
|
|
237
249
|
*/
|
|
238
250
|
plan: CreateInvoiceInputWithProductAndEmailAddress.Plan;
|
|
239
251
|
/**
|
|
240
|
-
* The properties of the product to create for this invoice.
|
|
241
|
-
*
|
|
252
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
253
|
+
* a new product inline.
|
|
242
254
|
*/
|
|
243
255
|
product: CreateInvoiceInputWithProductAndEmailAddress.Product;
|
|
244
256
|
/**
|
|
245
|
-
*
|
|
257
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
258
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
259
|
+
* charge will be processed immediately.
|
|
260
|
+
*/
|
|
261
|
+
automatically_finalizes_at?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
246
264
|
*/
|
|
247
265
|
charge_buyer_fee?: boolean | null;
|
|
248
266
|
/**
|
|
249
|
-
* The name of the customer
|
|
250
|
-
*
|
|
251
|
-
* company yet.
|
|
267
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
268
|
+
* is not yet a member of the company.
|
|
252
269
|
*/
|
|
253
270
|
customer_name?: string | null;
|
|
254
271
|
/**
|
|
255
|
-
* The
|
|
256
|
-
*
|
|
272
|
+
* The unique identifier of the payment method to charge. Required when
|
|
273
|
+
* collection_method is charge_automatically.
|
|
257
274
|
*/
|
|
258
275
|
payment_method_id?: string | null;
|
|
259
276
|
/**
|
|
@@ -264,11 +281,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
264
281
|
}
|
|
265
282
|
namespace CreateInvoiceInputWithProductAndEmailAddress {
|
|
266
283
|
/**
|
|
267
|
-
* The
|
|
284
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
285
|
+
* invoice.
|
|
268
286
|
*/
|
|
269
287
|
interface Plan {
|
|
270
288
|
/**
|
|
271
|
-
* The interval at which the plan charges (renewal plans).
|
|
289
|
+
* The interval in days at which the plan charges (renewal plans).
|
|
272
290
|
*/
|
|
273
291
|
billing_period?: number | null;
|
|
274
292
|
/**
|
|
@@ -280,13 +298,14 @@ export declare namespace InvoiceCreateParams {
|
|
|
280
298
|
*/
|
|
281
299
|
description?: string | null;
|
|
282
300
|
/**
|
|
283
|
-
* The
|
|
301
|
+
* The number of days until the membership expires and revokes access (expiration
|
|
302
|
+
* plans). For example, 365 for a one-year access period.
|
|
284
303
|
*/
|
|
285
304
|
expiration_days?: number | null;
|
|
286
305
|
/**
|
|
287
306
|
* An additional amount charged upon first purchase. Use only if a one time payment
|
|
288
307
|
* OR you want to charge an additional amount on top of the renewal price. Provided
|
|
289
|
-
* as a number in
|
|
308
|
+
* as a number in the specified currency. Eg: 10.43 for $10.43
|
|
290
309
|
*/
|
|
291
310
|
initial_price?: number | null;
|
|
292
311
|
/**
|
|
@@ -303,7 +322,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
303
322
|
release_method?: Shared.ReleaseMethod | null;
|
|
304
323
|
/**
|
|
305
324
|
* The amount the customer is charged every billing period. Use only if a recurring
|
|
306
|
-
* payment. Provided as a number in
|
|
325
|
+
* payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
|
|
307
326
|
*/
|
|
308
327
|
renewal_price?: number | null;
|
|
309
328
|
/**
|
|
@@ -315,7 +334,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
315
334
|
*/
|
|
316
335
|
trial_period_days?: number | null;
|
|
317
336
|
/**
|
|
318
|
-
*
|
|
337
|
+
* When true, the plan has unlimited stock (stock field is ignored). When false,
|
|
338
|
+
* purchases are limited by the stock field.
|
|
319
339
|
*/
|
|
320
340
|
unlimited_stock?: boolean | null;
|
|
321
341
|
/**
|
|
@@ -352,8 +372,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
352
372
|
}
|
|
353
373
|
}
|
|
354
374
|
/**
|
|
355
|
-
* The properties of the product to create for this invoice.
|
|
356
|
-
*
|
|
375
|
+
* The properties of the product to create for this invoice. Provide this to create
|
|
376
|
+
* a new product inline.
|
|
357
377
|
*/
|
|
358
378
|
interface Product {
|
|
359
379
|
/**
|
|
@@ -368,46 +388,50 @@ export declare namespace InvoiceCreateParams {
|
|
|
368
388
|
}
|
|
369
389
|
interface CreateInvoiceInputWithProductIDAndMemberID {
|
|
370
390
|
/**
|
|
371
|
-
*
|
|
372
|
-
*
|
|
391
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
392
|
+
* payment method, or send_invoice to email the customer.
|
|
373
393
|
*/
|
|
374
394
|
collection_method: Shared.CollectionMethod;
|
|
375
395
|
/**
|
|
376
|
-
* The company
|
|
396
|
+
* The unique identifier of the company to create this invoice for.
|
|
377
397
|
*/
|
|
378
398
|
company_id: string;
|
|
379
399
|
/**
|
|
380
|
-
* The date the invoice
|
|
400
|
+
* The date by which the invoice must be paid.
|
|
381
401
|
*/
|
|
382
402
|
due_date: string;
|
|
383
403
|
/**
|
|
384
|
-
* The member
|
|
385
|
-
*
|
|
386
|
-
* an email_address and customer_name.
|
|
404
|
+
* The unique identifier of an existing member to create this invoice for. If not
|
|
405
|
+
* provided, you must supply an email_address and customer_name.
|
|
387
406
|
*/
|
|
388
407
|
member_id: string;
|
|
389
408
|
/**
|
|
390
|
-
* The
|
|
409
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
410
|
+
* invoice.
|
|
391
411
|
*/
|
|
392
412
|
plan: CreateInvoiceInputWithProductIDAndMemberID.Plan;
|
|
393
413
|
/**
|
|
394
|
-
* The product
|
|
395
|
-
* invoice for an existing product.
|
|
414
|
+
* The unique identifier of an existing product to create this invoice for.
|
|
396
415
|
*/
|
|
397
416
|
product_id: string;
|
|
398
417
|
/**
|
|
399
|
-
*
|
|
418
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
419
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
420
|
+
* charge will be processed immediately.
|
|
421
|
+
*/
|
|
422
|
+
automatically_finalizes_at?: string | null;
|
|
423
|
+
/**
|
|
424
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
400
425
|
*/
|
|
401
426
|
charge_buyer_fee?: boolean | null;
|
|
402
427
|
/**
|
|
403
|
-
* The name of the customer
|
|
404
|
-
*
|
|
405
|
-
* company yet.
|
|
428
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
429
|
+
* is not yet a member of the company.
|
|
406
430
|
*/
|
|
407
431
|
customer_name?: string | null;
|
|
408
432
|
/**
|
|
409
|
-
* The
|
|
410
|
-
*
|
|
433
|
+
* The unique identifier of the payment method to charge. Required when
|
|
434
|
+
* collection_method is charge_automatically.
|
|
411
435
|
*/
|
|
412
436
|
payment_method_id?: string | null;
|
|
413
437
|
/**
|
|
@@ -418,11 +442,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
418
442
|
}
|
|
419
443
|
namespace CreateInvoiceInputWithProductIDAndMemberID {
|
|
420
444
|
/**
|
|
421
|
-
* The
|
|
445
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
446
|
+
* invoice.
|
|
422
447
|
*/
|
|
423
448
|
interface Plan {
|
|
424
449
|
/**
|
|
425
|
-
* The interval at which the plan charges (renewal plans).
|
|
450
|
+
* The interval in days at which the plan charges (renewal plans).
|
|
426
451
|
*/
|
|
427
452
|
billing_period?: number | null;
|
|
428
453
|
/**
|
|
@@ -434,13 +459,14 @@ export declare namespace InvoiceCreateParams {
|
|
|
434
459
|
*/
|
|
435
460
|
description?: string | null;
|
|
436
461
|
/**
|
|
437
|
-
* The
|
|
462
|
+
* The number of days until the membership expires and revokes access (expiration
|
|
463
|
+
* plans). For example, 365 for a one-year access period.
|
|
438
464
|
*/
|
|
439
465
|
expiration_days?: number | null;
|
|
440
466
|
/**
|
|
441
467
|
* An additional amount charged upon first purchase. Use only if a one time payment
|
|
442
468
|
* OR you want to charge an additional amount on top of the renewal price. Provided
|
|
443
|
-
* as a number in
|
|
469
|
+
* as a number in the specified currency. Eg: 10.43 for $10.43
|
|
444
470
|
*/
|
|
445
471
|
initial_price?: number | null;
|
|
446
472
|
/**
|
|
@@ -457,7 +483,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
457
483
|
release_method?: Shared.ReleaseMethod | null;
|
|
458
484
|
/**
|
|
459
485
|
* The amount the customer is charged every billing period. Use only if a recurring
|
|
460
|
-
* payment. Provided as a number in
|
|
486
|
+
* payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
|
|
461
487
|
*/
|
|
462
488
|
renewal_price?: number | null;
|
|
463
489
|
/**
|
|
@@ -469,7 +495,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
469
495
|
*/
|
|
470
496
|
trial_period_days?: number | null;
|
|
471
497
|
/**
|
|
472
|
-
*
|
|
498
|
+
* When true, the plan has unlimited stock (stock field is ignored). When false,
|
|
499
|
+
* purchases are limited by the stock field.
|
|
473
500
|
*/
|
|
474
501
|
unlimited_stock?: boolean | null;
|
|
475
502
|
/**
|
|
@@ -508,45 +535,50 @@ export declare namespace InvoiceCreateParams {
|
|
|
508
535
|
}
|
|
509
536
|
interface CreateInvoiceInputWithProductIDAndEmailAddress {
|
|
510
537
|
/**
|
|
511
|
-
*
|
|
512
|
-
*
|
|
538
|
+
* How the invoice should be collected. Use charge_automatically to charge a stored
|
|
539
|
+
* payment method, or send_invoice to email the customer.
|
|
513
540
|
*/
|
|
514
541
|
collection_method: Shared.CollectionMethod;
|
|
515
542
|
/**
|
|
516
|
-
* The company
|
|
543
|
+
* The unique identifier of the company to create this invoice for.
|
|
517
544
|
*/
|
|
518
545
|
company_id: string;
|
|
519
546
|
/**
|
|
520
|
-
* The date the invoice
|
|
547
|
+
* The date by which the invoice must be paid.
|
|
521
548
|
*/
|
|
522
549
|
due_date: string;
|
|
523
550
|
/**
|
|
524
|
-
* The email address
|
|
525
|
-
*
|
|
551
|
+
* The email address of the customer. Required when creating an invoice for a
|
|
552
|
+
* customer who is not yet a member of the company.
|
|
526
553
|
*/
|
|
527
554
|
email_address: string;
|
|
528
555
|
/**
|
|
529
|
-
* The
|
|
556
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
557
|
+
* invoice.
|
|
530
558
|
*/
|
|
531
559
|
plan: CreateInvoiceInputWithProductIDAndEmailAddress.Plan;
|
|
532
560
|
/**
|
|
533
|
-
* The product
|
|
534
|
-
* invoice for an existing product.
|
|
561
|
+
* The unique identifier of an existing product to create this invoice for.
|
|
535
562
|
*/
|
|
536
563
|
product_id: string;
|
|
537
564
|
/**
|
|
538
|
-
*
|
|
565
|
+
* The date and time when the invoice will be automatically finalized and charged.
|
|
566
|
+
* Only valid when collection_method is charge_automatically. If not provided, the
|
|
567
|
+
* charge will be processed immediately.
|
|
568
|
+
*/
|
|
569
|
+
automatically_finalizes_at?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
* Whether to charge the customer a buyer fee on this invoice.
|
|
539
572
|
*/
|
|
540
573
|
charge_buyer_fee?: boolean | null;
|
|
541
574
|
/**
|
|
542
|
-
* The name of the customer
|
|
543
|
-
*
|
|
544
|
-
* company yet.
|
|
575
|
+
* The name of the customer. Required when creating an invoice for a customer who
|
|
576
|
+
* is not yet a member of the company.
|
|
545
577
|
*/
|
|
546
578
|
customer_name?: string | null;
|
|
547
579
|
/**
|
|
548
|
-
* The
|
|
549
|
-
*
|
|
580
|
+
* The unique identifier of the payment method to charge. Required when
|
|
581
|
+
* collection_method is charge_automatically.
|
|
550
582
|
*/
|
|
551
583
|
payment_method_id?: string | null;
|
|
552
584
|
/**
|
|
@@ -557,11 +589,12 @@ export declare namespace InvoiceCreateParams {
|
|
|
557
589
|
}
|
|
558
590
|
namespace CreateInvoiceInputWithProductIDAndEmailAddress {
|
|
559
591
|
/**
|
|
560
|
-
* The
|
|
592
|
+
* The plan attributes defining the price, currency, and billing interval for this
|
|
593
|
+
* invoice.
|
|
561
594
|
*/
|
|
562
595
|
interface Plan {
|
|
563
596
|
/**
|
|
564
|
-
* The interval at which the plan charges (renewal plans).
|
|
597
|
+
* The interval in days at which the plan charges (renewal plans).
|
|
565
598
|
*/
|
|
566
599
|
billing_period?: number | null;
|
|
567
600
|
/**
|
|
@@ -573,13 +606,14 @@ export declare namespace InvoiceCreateParams {
|
|
|
573
606
|
*/
|
|
574
607
|
description?: string | null;
|
|
575
608
|
/**
|
|
576
|
-
* The
|
|
609
|
+
* The number of days until the membership expires and revokes access (expiration
|
|
610
|
+
* plans). For example, 365 for a one-year access period.
|
|
577
611
|
*/
|
|
578
612
|
expiration_days?: number | null;
|
|
579
613
|
/**
|
|
580
614
|
* An additional amount charged upon first purchase. Use only if a one time payment
|
|
581
615
|
* OR you want to charge an additional amount on top of the renewal price. Provided
|
|
582
|
-
* as a number in
|
|
616
|
+
* as a number in the specified currency. Eg: 10.43 for $10.43
|
|
583
617
|
*/
|
|
584
618
|
initial_price?: number | null;
|
|
585
619
|
/**
|
|
@@ -596,7 +630,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
596
630
|
release_method?: Shared.ReleaseMethod | null;
|
|
597
631
|
/**
|
|
598
632
|
* The amount the customer is charged every billing period. Use only if a recurring
|
|
599
|
-
* payment. Provided as a number in
|
|
633
|
+
* payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
|
|
600
634
|
*/
|
|
601
635
|
renewal_price?: number | null;
|
|
602
636
|
/**
|
|
@@ -608,7 +642,8 @@ export declare namespace InvoiceCreateParams {
|
|
|
608
642
|
*/
|
|
609
643
|
trial_period_days?: number | null;
|
|
610
644
|
/**
|
|
611
|
-
*
|
|
645
|
+
* When true, the plan has unlimited stock (stock field is ignored). When false,
|
|
646
|
+
* purchases are limited by the stock field.
|
|
612
647
|
*/
|
|
613
648
|
unlimited_stock?: boolean | null;
|
|
614
649
|
/**
|
|
@@ -648,7 +683,7 @@ export declare namespace InvoiceCreateParams {
|
|
|
648
683
|
}
|
|
649
684
|
export interface InvoiceListParams extends CursorPageParams {
|
|
650
685
|
/**
|
|
651
|
-
* The
|
|
686
|
+
* The unique identifier of the company to list invoices for.
|
|
652
687
|
*/
|
|
653
688
|
company_id: string;
|
|
654
689
|
/**
|
|
@@ -656,15 +691,15 @@ export interface InvoiceListParams extends CursorPageParams {
|
|
|
656
691
|
*/
|
|
657
692
|
before?: string | null;
|
|
658
693
|
/**
|
|
659
|
-
* Filter invoices by their collection method
|
|
694
|
+
* Filter invoices by their collection method.
|
|
660
695
|
*/
|
|
661
696
|
collection_methods?: Array<Shared.CollectionMethod> | null;
|
|
662
697
|
/**
|
|
663
|
-
*
|
|
698
|
+
* Only return invoices created after this timestamp.
|
|
664
699
|
*/
|
|
665
700
|
created_after?: string | null;
|
|
666
701
|
/**
|
|
667
|
-
*
|
|
702
|
+
* Only return invoices created before this timestamp.
|
|
668
703
|
*/
|
|
669
704
|
created_before?: string | null;
|
|
670
705
|
/**
|
|
@@ -684,11 +719,12 @@ export interface InvoiceListParams extends CursorPageParams {
|
|
|
684
719
|
*/
|
|
685
720
|
order?: 'id' | 'created_at' | 'due_date' | null;
|
|
686
721
|
/**
|
|
687
|
-
*
|
|
722
|
+
* Filter invoices to only those associated with these specific product
|
|
723
|
+
* identifiers.
|
|
688
724
|
*/
|
|
689
725
|
product_ids?: Array<string> | null;
|
|
690
726
|
/**
|
|
691
|
-
*
|
|
727
|
+
* Filter invoices by their current status.
|
|
692
728
|
*/
|
|
693
729
|
statuses?: Array<Shared.InvoiceStatus> | null;
|
|
694
730
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invoices.d.mts","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"invoices.d.mts","sourceRoot":"","sources":["../src/resources/invoices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,eAAe,CAAC;IAIlE;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAE1C,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,wCAAwC,GAC5D,mBAAmB,CAAC,4CAA4C,GAChE,mBAAmB,CAAC,0CAA0C,GAC9D,mBAAmB,CAAC,8CAA8C,CAAC;AAEvE,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,wCAAwC;QACvD;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,EAAE,wCAAwC,CAAC,IAAI,CAAC;QAEpD;;;WAGG;QACH,OAAO,EAAE,wCAAwC,CAAC,OAAO,CAAC;QAE1D;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,wCAAwC,CAAC;QACxD;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACrC;KACF;IAED,UAAiB,4CAA4C;QAC3D;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,4CAA4C,CAAC,IAAI,CAAC;QAExD;;;WAGG;QACH,OAAO,EAAE,4CAA4C,CAAC,OAAO,CAAC;QAE9D;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,4CAA4C,CAAC;QAC5D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;QAED;;;WAGG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACrC;KACF;IAED,UAAiB,0CAA0C;QACzD;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,EAAE,0CAA0C,CAAC,IAAI,CAAC;QAEtD;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,0CAA0C,CAAC;QAC1D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;KACF;IAED,UAAiB,8CAA8C;QAC7D;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,IAAI,EAAE,8CAA8C,CAAC,IAAI,CAAC;QAE1D;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,8CAA8C,CAAC;QAC9D;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;YAE/C;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC;;;;eAIG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;YAE7C;;;eAGG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAElC;;;eAGG;YACH,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEnB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aAC3B;SACF;KACF;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,CAAC;IAEhD;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH;AAED,OAAO,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
|