API Reference Polarex v#0.2.3
View SourceModules
Provides struct and type for a Address
Provides struct and type for a AlreadyActiveSubscriptionError
Provides struct and type for a AlreadyCanceledSubscription
Provides struct and types for a Archived
Provides struct and type for a AttachedCustomField
Provides struct and type for a AttachedCustomFieldCreate
Provides struct and type for a AuthorizationCodeTokenRequest
Provides struct and type for a AuthorizeOrganization
Provides struct and type for a AuthorizeResponseOrganization
Provides struct and type for a AuthorizeResponseUser
Provides struct and type for a AuthorizeUser
Provides struct and type for a BenefitCustom
Provides struct and type for a BenefitCustomCreate
Provides struct and type for a BenefitCustomCreateProperties
Provides struct and type for a BenefitCustomProperties
Provides struct and type for a BenefitCustomSubscriber
Provides struct and type for a BenefitCustomSubscriberProperties
Provides struct and type for a BenefitCustomUpdate
Provides struct and type for a BenefitDiscord
Provides struct and type for a BenefitDiscordCreate
Provides struct and type for a BenefitDiscordCreateProperties
Provides struct and type for a BenefitDiscordProperties
Provides struct and type for a BenefitDiscordSubscriber
Provides struct and type for a BenefitDiscordSubscriberProperties
Provides struct and type for a BenefitDiscordUpdate
Provides struct and type for a BenefitDownloadables
Provides struct and type for a BenefitDownloadablesCreate
Provides struct and type for a BenefitDownloadablesCreateProperties
Provides struct and type for a BenefitDownloadablesProperties
Provides struct and type for a BenefitDownloadablesSubscriber
Provides struct and type for a BenefitDownloadablesSubscriberProperties
Provides struct and type for a BenefitDownloadablesUpdate
Provides struct and type for a BenefitGitHubRepository
Provides struct and type for a BenefitGitHubRepositoryCreate
Provides struct and type for a BenefitGitHubRepositoryCreateProperties
Provides struct and type for a BenefitGitHubRepositoryProperties
Provides struct and type for a BenefitGitHubRepositorySubscriber
Provides struct and type for a BenefitGitHubRepositorySubscriberProperties
Provides struct and type for a BenefitGitHubRepositoryUpdate
Provides struct and type for a BenefitGrant
Provides struct and type for a BenefitGrantDiscordProperties
Provides struct and type for a BenefitGrantDownloadablesProperties
Provides struct and type for a BenefitGrantError
Provides struct and type for a BenefitGrantGitHubRepositoryProperties
Provides struct and type for a BenefitGrantLicenseKeysProperties
Provides struct and type for a BenefitGrantMeterCreditProperties
Provides API endpoints related to benefit grants
Provides struct and type for a BenefitLicenseKeyActivationCreateProperties
Provides struct and type for a BenefitLicenseKeyActivationProperties
Provides struct and type for a BenefitLicenseKeyExpirationProperties
Provides struct and type for a BenefitLicenseKeys
Provides struct and type for a BenefitLicenseKeysCreate
Provides struct and type for a BenefitLicenseKeysCreateProperties
Provides struct and type for a BenefitLicenseKeysProperties
Provides struct and type for a BenefitLicenseKeysSubscriber
Provides struct and type for a BenefitLicenseKeysSubscriberProperties
Provides struct and type for a BenefitLicenseKeysUpdate
Provides struct and type for a BenefitMetadata
Provides struct and type for a BenefitMeterCredit
Provides struct and type for a BenefitMeterCreditCreate
Provides struct and type for a BenefitMeterCreditCreateProperties
Provides struct and type for a BenefitMeterCreditProperties
Provides struct and type for a BenefitMeterCreditSubscriber
Provides struct and type for a BenefitMeterCreditSubscriberProperties
Provides struct and type for a BenefitMeterCreditUpdate
Provides struct and type for a BenefitPublic
Provides API endpoints related to benefits
Provides struct and type for a CardPayment
Provides struct and type for a CardPaymentMetadata
Provides struct and type for a Checkout
Provides struct and type for a CheckoutConfirmStripe
Provides struct and type for a CheckoutCustomerBillingAddressFields
Provides struct and type for a CheckoutLink
Provides struct and type for a CheckoutLinkCreateProduct
Provides struct and type for a CheckoutLinkCreateProductPrice
Provides struct and type for a CheckoutLinkCreateProducts
Provides struct and type for a CheckoutLinkProduct
Provides struct and type for a CheckoutLinkUpdate
Provides API endpoints related to checkout links
Provides struct and type for a CheckoutProduct
Provides struct and type for a CheckoutProductsCreate
Provides struct and type for a CheckoutPublic
Provides struct and type for a CheckoutPublicConfirmed
Provides struct and type for a CheckoutUpdate
Provides struct and type for a CheckoutUpdateCustomerMetadata
Provides struct and type for a CheckoutUpdatePublic
Provides API endpoints related to checkouts
Provides API endpoints related to clients
Provides struct and types for a Conditions
Provides struct and type for a CountAggregation
Provides struct and type for a CustomFieldCheckbox
Provides struct and type for a CustomFieldCheckboxProperties
Provides struct and type for a CustomFieldCreateCheckbox
Provides struct and type for a CustomFieldCreateDate
Provides struct and type for a CustomFieldCreateNumber
Provides struct and type for a CustomFieldCreateSelect
Provides struct and type for a CustomFieldCreateText
Provides struct and types for a CustomFieldData
Provides struct and type for a CustomFieldDate
Provides struct and type for a CustomFieldDateProperties
Provides struct and type for a CustomFieldNumber
Provides struct and type for a CustomFieldNumberProperties
Provides struct and type for a CustomFieldSelect
Provides struct and type for a CustomFieldSelectOption
Provides struct and type for a CustomFieldSelectProperties
Provides struct and type for a CustomFieldText
Provides struct and type for a CustomFieldTextProperties
Provides struct and type for a CustomFieldUpdateCheckbox
Provides struct and type for a CustomFieldUpdateDate
Provides struct and type for a CustomFieldUpdateNumber
Provides struct and type for a CustomFieldUpdateSelect
Provides struct and type for a CustomFieldUpdateText
Provides API endpoints related to custom fields
Provides struct and type for a Customer
Provides struct and type for a CustomerBenefitGrantCustom
Provides struct and type for a CustomerBenefitGrantCustomUpdate
Provides struct and type for a CustomerBenefitGrantDiscord
Provides struct and type for a CustomerBenefitGrantDiscordPropertiesUpdate
Provides struct and type for a CustomerBenefitGrantDiscordUpdate
Provides struct and type for a CustomerBenefitGrantDownloadables
Provides struct and type for a CustomerBenefitGrantDownloadablesUpdate
Provides struct and type for a CustomerBenefitGrantGitHubRepository
Provides struct and type for a CustomerBenefitGrantGitHubRepositoryPropertiesUpdate
Provides struct and type for a CustomerBenefitGrantGitHubRepositoryUpdate
Provides struct and type for a CustomerBenefitGrantLicenseKeys
Provides struct and type for a CustomerBenefitGrantLicenseKeysUpdate
Provides struct and type for a CustomerBenefitGrantMeterCredit
Provides struct and type for a CustomerBenefitGrantMeterCreditUpdate
Provides struct and type for a CustomerCreate
Provides struct and type for a CustomerCustomerMeter
Provides struct and type for a CustomerCustomerMeterMeter
Provides struct and types for a CustomerMetadata
Provides struct and type for a CustomerMeter
Provides API endpoints related to customer meters
Provides struct and type for a CustomerOrder
Provides struct and type for a CustomerOrderInvoice
Provides struct and type for a CustomerOrderProduct
Provides struct and type for a CustomerOrderSubscription
Provides struct and type for a CustomerOrderUpdate
Provides struct and type for a CustomerOrganization
Provides struct and type for a CustomerPaymentMethodCreate
Provides API endpoints related to customer portal
Provides struct and type for a CustomerPortalCustomer
Provides struct and type for a CustomerPortalCustomerUpdate
Provides struct and type for a CustomerProduct
Provides struct and type for a CustomerSession
Provides struct and type for a CustomerSessionCustomerExternalIDCreate
Provides struct and type for a CustomerSessionCustomerIDCreate
Provides API endpoint related to customer sessions
Provides struct and type for a CustomerState
Provides struct and type for a CustomerStateBenefitGrant
Provides struct and type for a CustomerStateMeter
Provides struct and type for a CustomerStateSubscription
Provides struct and type for a CustomerStateSubscriptionMeter
Provides struct and type for a CustomerSubscription
Provides struct and type for a CustomerSubscriptionCancel
Provides struct and type for a CustomerSubscriptionMeter
Provides struct and type for a CustomerSubscriptionMeterMeter
Provides struct and type for a CustomerSubscriptionProduct
Provides struct and type for a CustomerSubscriptionUpdateProduct
Provides struct and type for a CustomerUpdate
Provides struct and type for a CustomerUpdateExternalID
Provides API endpoints related to customers
Provides struct and type for a DiscountFixedOnceForeverDuration
Provides struct and type for a DiscountFixedOnceForeverDurationCreate
Provides struct and type for a DiscountFixedRepeatDuration
Provides struct and type for a DiscountFixedRepeatDurationCreate
Provides struct and type for a DiscountPercentageOnceForeverDuration
Provides struct and type for a DiscountPercentageOnceForeverDurationCreate
Provides struct and type for a DiscountPercentageRepeatDuration
Provides struct and type for a DiscountPercentageRepeatDurationCreate
Provides struct and type for a DiscountProduct
Provides struct and type for a DiscountUpdate
Provides API endpoints related to discounts
Provides API endpoints related to documented
Provides struct and type for a DownloadableFileCreate
Provides struct and type for a DownloadableFileRead
Provides struct and type for a DownloadableRead
Provides API endpoints related to downloadables
Provides struct and type for a EventCreateCustomer
Provides struct and type for a EventCreateExternalCustomer
Provides struct and type for a EventName
Provides API endpoints related to events
Provides struct and type for a EventsIngest
Provides struct and type for a EventsIngestResponse
Provides struct and type for a ExpiredCheckoutError
Provides API endpoints related to featured
Provides struct and type for a FileDownload
Provides struct and type for a FilePatch
Provides struct and type for a FileUpload
Provides struct and type for a FileUploadCompleted
Provides API endpoints related to files
Provides struct and type for a Filter
Provides struct and type for a FilterClause
Provides struct and type for a GenericPayment
Provides struct and type for a HTTPValidationError
Provides struct and types for a Headers
Provides struct and type for a IntrospectTokenRequest
Provides struct and type for a IntrospectTokenResponse
Provides struct and type for a InvoiceAlreadyExists
Provides struct and type for a LicenseKeyActivate
Provides struct and type for a LicenseKeyActivationBase
Provides struct and type for a LicenseKeyActivationRead
Provides struct and type for a LicenseKeyCustomer
Provides struct and type for a LicenseKeyDeactivate
Provides struct and type for a LicenseKeyRead
Provides struct and type for a LicenseKeyUpdate
Provides struct and type for a LicenseKeyValidate
Provides struct and type for a LicenseKeyWithActivations
Provides API endpoints related to license keys
Provides struct and type for a ListResource
Provides struct and type for a ListResourceBenefit
Provides struct and type for a ListResourceBenefitGrant
Provides struct and type for a ListResourceCheckout
Provides struct and type for a ListResourceCheckoutLink
Provides struct and type for a ListResourceCustomField
Provides struct and type for a ListResourceCustomer
Provides struct and type for a ListResourceCustomerBenefitGrant
Provides struct and type for a ListResourceCustomerCustomerMeter
Provides struct and type for a ListResourceCustomerMeter
Provides struct and type for a ListResourceCustomerOrder
Provides struct and type for a ListResourceCustomerSubscription
Provides struct and type for a ListResourceDiscount
Provides struct and type for a ListResourceDownloadableRead
Provides struct and type for a ListResourceEvent
Provides struct and type for a ListResourceEventName
Provides struct and type for a ListResourceFileRead
Provides struct and type for a ListResourceLicenseKeyRead
Provides struct and type for a ListResourceMeter
Provides struct and type for a ListResourceOAuth2Client
Provides struct and type for a ListResourceOrder
Provides struct and type for a ListResourceOrganization
Provides struct and type for a ListResourceProduct
Provides struct and type for a ListResourceRefund
Provides struct and type for a ListResourceSubscription
Provides struct and type for a ListResourceUnionPaymentMethodCardPaymentMethodGeneric
Provides struct and type for a ListResourceWebhookDelivery
Provides struct and type for a ListResourceWebhookEndpoint
Provides API endpoints related to mcp
Provides struct and types for a Meta
Provides struct and types for a Metadata
Provides struct and type for a Meter
Provides struct and type for a MeterCreate
Provides struct and type for a MeterQuantities
Provides struct and type for a MeterQuantity
Provides struct and type for a MeterUpdate
Provides API endpoints related to meters
Provides struct and type for a Metric
Provides struct and type for a MetricPeriod
Provides API endpoints related to metrics
Provides struct and type for a MetricsIntervalLimit
Provides struct and type for a MetricsIntervalsLimits
Provides struct and type for a MetricsLimits
Provides struct and type for a MetricsResponse
Provides struct and type for a MetricsTotals
Provides struct and type for a MissingInvoiceBillingDetails
Provides struct and type for a NotOpenCheckout
Provides struct and type for a NotPaidOrder
Provides struct and type for a NotPermitted
Provides struct and type for a OAuth2Client
Provides struct and type for a OAuth2ClientConfiguration
Provides struct and type for a OAuth2ClientConfigurationUpdate
Provides struct and type for a OAuth2ClientPublic
Provides API endpoints related to oauth2
Provides struct and type for a OauthAccounts
Provides struct and type for a Order
Provides struct and type for a OrderCustomer
Provides struct and type for a OrderInvoice
Provides struct and type for a OrderItemSchema
Provides struct and type for a OrderProduct
Provides struct and type for a OrderSubscription
Provides struct and type for a OrderUpdate
Provides API endpoints related to orders
Provides struct and type for a Organization
Provides struct and type for a OrganizationAvatarFileCreate
Provides struct and type for a OrganizationAvatarFileRead
Provides struct and type for a OrganizationCreate
Provides struct and type for a OrganizationDetails
Provides struct and type for a OrganizationFeatureSettings
Provides struct and type for a OrganizationSocialLink
Provides struct and type for a OrganizationSubscriptionSettings
Provides struct and type for a OrganizationUpdate
Provides API endpoints related to organizations
Provides struct and type for a Pagination
Provides struct and type for a PaymentError
Provides struct and type for a PaymentMethodCard
Provides struct and type for a PaymentMethodCardData
Provides struct and type for a PaymentMethodGeneric
Provides struct and types for a PaymentProcessorMetadata
Provides API endpoints related to payments
Provides struct and type for a Product
Provides struct and type for a ProductBenefitsUpdate
Provides struct and type for a ProductCreate
Provides struct and type for a ProductMediaFileCreate
Provides struct and type for a ProductMediaFileRead
Provides struct and type for a ProductPriceCustomCreate
Provides struct and type for a ProductPriceFixedCreate
Provides struct and type for a ProductPriceFreeCreate
Provides struct and type for a ProductPriceMeteredUnitCreate
Provides struct and type for a ProductUpdate
Provides API endpoints related to products
Provides struct and type for a PropertyAggregation
Provides struct and type for a RefreshTokenRequest
Provides struct and type for a Refund
Provides struct and type for a RefundAmountTooHigh
Provides struct and type for a RefundCreate
Provides struct and type for a RefundedAlready
Provides API endpoints related to refunds
Provides struct and type for a ResourceNotFound
Provides struct and type for a RevokeTokenRequest
Provides struct and type for a S3DownloadURL
Provides struct and type for a S3FileCreateMultipart
Provides struct and type for a S3FileCreatePart
Provides struct and type for a S3FileUploadCompletedPart
Provides struct and type for a S3FileUploadMultipart
Provides struct and type for a S3FileUploadPart
Provides struct and type for a Subscription
Provides struct and type for a SubscriptionCancel
Provides struct and type for a SubscriptionCustomer
Provides struct and type for a SubscriptionMeter
Provides struct and type for a SubscriptionRevoke
Provides struct and type for a SubscriptionUpdateDiscount
Provides struct and type for a SubscriptionUpdateProduct
Provides API endpoints related to subscriptions
This module is not automatically generated. It is manually created to provide a Req request client for the Polar API.
This module's purpose is to automatically translate each response type from the generated API.
It exposes a single function called translate
that receives the type and the value to parse.
Provides struct and type for a TokenResponse
Provides struct and type for a Unauthorized
Provides struct and type for a UserEvent
Provides struct and type for a UserInfoOrganization
Provides struct and type for a UserInfoUser
Provides struct and type for a ValidatedLicenseKey
Provides struct and type for a ValidationError
Provides struct and type for a WebhookDelivery
Provides struct and type for a WebhookEndpoint
Provides struct and type for a WebhookEndpointCreate
Provides struct and type for a WebhookEndpointUpdate
Provides struct and type for a WebhookEvent
Provides API endpoints related to webhooks