API Reference Polarex v#0.8.2

Root module for Polarex.

Provides struct and type for a Address

Provides struct and type for a AddressInput

Provides struct and type for a AlreadyActiveSubscriptionError

Provides struct and type for a AlreadyCanceledSubscription

Provides struct and type for a AmbiguousExternalCustomerID

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 BenefitDownloadableFile

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 BenefitFeatureFlag

Provides struct and type for a BenefitFeatureFlagCreate

Provides struct and type for a BenefitFeatureFlagSubscriber

Provides struct and type for a BenefitFeatureFlagUpdate

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 struct and type for a BenefitGrantSlackSharedChannelProperties

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 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 struct and type for a BenefitSlackSharedChannel

Provides struct and type for a BenefitSlackSharedChannelCreate

Provides struct and type for a BenefitSlackSharedChannelCreateProperties

Provides struct and type for a BenefitSlackSharedChannelProperties

Provides struct and type for a BenefitSlackSharedChannelSubscriber

Provides struct and type for a BenefitSlackSharedChannelUpdate

Provides struct and type for a BenefitSubscriberOrganization

Provides API endpoints related to benefits

Provides struct and type for a CannotCreateOrganizationError

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 CheckoutBillingAddressFields

Provides struct and type for a CheckoutConfirmStripe

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 CheckoutOrganization

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 CheckoutUpdatePublic

Provides API endpoints related to checkouts

Provides API endpoints related to clients

Provides struct and type for a CostMetadataInput

Provides struct and type for a CostMetadataOutput

Provides struct and type for a CountAggregation

Provides struct and type for a CursorPagination

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 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 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 CustomerBenefitGrantFeatureFlag

Provides struct and type for a CustomerBenefitGrantFeatureFlagUpdate

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 CustomerBenefitGrantSlackSharedChannel

Provides struct and type for a CustomerBenefitGrantSlackSharedChannelPropertiesUpdate

Provides struct and type for a CustomerBenefitGrantSlackSharedChannelUpdate

Provides struct and type for a CustomerCustomerMeter

Provides struct and type for a CustomerCustomerMeterMeter

Provides struct and type for a CustomerCustomerSession

Provides struct and type for a CustomerEmailUpdateRequest

Provides struct and type for a CustomerEmailUpdateVerifyRequest

Provides struct and type for a CustomerEmailUpdateVerifyResponse

Provides struct and type for a CustomerIndividual

Provides struct and type for a CustomerIndividualCreate

Provides struct and type for a CustomerMeter

Provides API endpoints related to customer meters

Provides struct and type for a CustomerNotReady

Provides struct and type for a CustomerOrder

Provides struct and type for a CustomerOrderConfirmPayment

Provides struct and type for a CustomerOrderInvoice

Provides struct and type for a CustomerOrderPaymentConfirmation

Provides struct and type for a CustomerOrderPaymentStatus

Provides struct and type for a CustomerOrderProduct

Provides struct and type for a CustomerOrderReceipt

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 CustomerOrganizationData

Provides struct and type for a CustomerOrganizationFeatureSettings

Provides struct and type for a CustomerPaymentMethodCard

Provides struct and type for a CustomerPaymentMethodConfirm

Provides struct and type for a CustomerPaymentMethodCreate

Provides struct and type for a CustomerPaymentMethodCreateRequiresActionResponse

Provides struct and type for a CustomerPaymentMethodCreateSucceededResponse

Provides struct and type for a CustomerPaymentMethodGeneric

Provides API endpoints related to customer portal

Provides struct and type for a CustomerPortalCustomer

Provides struct and type for a CustomerPortalCustomerSettings

Provides struct and type for a CustomerPortalCustomerUpdate

Provides struct and type for a CustomerPortalMember

Provides struct and type for a CustomerPortalMemberCreate

Provides struct and type for a CustomerPortalMemberUpdate

Provides struct and type for a CustomerPortalSubscriptionSettings

Provides struct and type for a CustomerPortalUsageSettings

Provides struct and type for a CustomerProduct

Provides struct and type for a CustomerSeat

Provides struct and type for a CustomerSeatAssign

Provides struct and type for a CustomerSeatClaimResponse

Provides API endpoints related to customer seats

Provides API endpoints related to customer session

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 CustomerStateBenefitGrant

Provides struct and type for a CustomerStateIndividual

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 CustomerStateTeam

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 CustomerSubscriptionPause

Provides struct and type for a CustomerSubscriptionProduct

Provides struct and type for a CustomerSubscriptionResume

Provides struct and type for a CustomerSubscriptionUpdateClear

Provides struct and type for a CustomerSubscriptionUpdateProduct

Provides struct and type for a CustomerSubscriptionUpdateSeats

Provides struct and type for a CustomerTeam

Provides struct and type for a CustomerTeamCreate

Provides struct and type for a CustomerUpdate

Provides struct and type for a CustomerUpdateExternalID

Provides struct and type for a CustomerWallet

Provides API endpoints related to customers

Provides struct and type for a DiscountFixedCreate

Provides struct and type for a DiscountFixedOnceForeverDuration

Provides struct and type for a DiscountFixedRepeatDuration

Provides struct and type for a DiscountPercentageCreate

Provides struct and type for a DiscountPercentageOnceForeverDuration

Provides struct and type for a DiscountPercentageRepeatDuration

Provides struct and type for a DiscountProduct

Provides struct and type for a DiscountRedemptionLimitReached

Provides struct and type for a DiscountUpdate

Provides API endpoints related to discounts

Provides struct and type for a Dispute

Provides struct and type for a DisputeAutoAcceptNotEnabled

Provides struct and type for a DisputeCustomer

Provides struct and type for a DisputeNotOpenError

Provides API endpoints related to disputes

Provides struct and type for a DownloadableFileCreate

Provides struct and type for a DownloadableFileRead

Provides struct and type for a DownloadableRead

Provides API endpoint related to downloadables

A failed Polar API call.

Provides struct and type for a EventCreateCustomer

Provides struct and type for a EventCreateExternalCustomer

Provides struct and type for a EventMetadataInput

Provides struct and type for a EventMetadataOutput

Provides struct and type for a EventName

Provides struct and type for a EventType

Provides struct and type for a EventTypeUpdate

Provides struct and type for a EventTypeWithStats

Provides API endpoints related to event types

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 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 type for a InactiveSubscription

Provides struct and type for a IntrospectTokenRequest

Provides struct and type for a IntrospectTokenResponse

Provides struct and type for a LLMMetadata

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 ListResourceBenefit

Provides struct and type for a ListResourceBenefitDownloadableFile

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 ListResourceCustomerPaymentMethod

Provides struct and type for a ListResourceCustomerPortalMember

Provides struct and type for a ListResourceCustomerSubscription

Provides struct and type for a ListResourceCustomerWallet

Provides struct and type for a ListResourceDiscount

Provides struct and type for a ListResourceDispute

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 ListResourceEventTypeWithStats

Provides struct and type for a ListResourceFileRead

Provides struct and type for a ListResourceLicenseKeyRead

Provides struct and type for a ListResourceMember

Provides struct and type for a ListResourceMeter

Provides struct and type for a ListResourceOrder

Provides struct and type for a ListResourceOrganization

Provides struct and type for a ListResourceOrganizationAccessToken

Provides struct and type for a ListResourcePayment

Provides struct and type for a ListResourcePaymentMethod

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 ListResourceWebhookDelivery

Provides struct and type for a ListResourceWebhookEndpoint

Provides struct and type for a ListResourceWithCursorPaginationEvent

Provides struct and type for a ManualRetryLimitExceeded

Provides API endpoints related to mcp

Provides struct and type for a Member

Provides struct and type for a MemberCreate

Provides struct and type for a MemberCreateFromCustomer

Provides struct and type for a MemberOwnerCreate

Provides struct and type for a MemberUpdate

Provides API endpoints related to members

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 MetricDashboardCreate

Provides struct and type for a MetricDashboardSchema

Provides struct and type for a MetricDashboardUpdate

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 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 OffSessionChargesNotEnabled

Provides struct and type for a Order

Provides struct and type for a OrderCreate

Provides struct and type for a OrderCustomer

Provides struct and type for a OrderFinalize

Provides struct and type for a OrderInvoice

Provides struct and type for a OrderItemSchema

Provides struct and type for a OrderNotDraft

Provides struct and type for a OrderNotEligibleForInvoice

Provides struct and type for a OrderNotEligibleForRetry

Provides struct and type for a OrderProduct

Provides struct and type for a OrderReceipt

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 OrganizationAccessToken

Provides struct and type for a OrganizationAccessTokenCreate

Provides struct and type for a OrganizationAccessTokenCreateResponse

Provides struct and type for a OrganizationAccessTokenUpdate

Provides API endpoints related to organization access tokens

Provides struct and type for a OrganizationAvatarFileCreate

Provides struct and type for a OrganizationAvatarFileRead

Provides struct and type for a OrganizationCapabilities

Provides struct and type for a OrganizationCreate

Provides struct and type for a OrganizationCustomerEmailSettings

Provides struct and type for a OrganizationCustomerPortalSettings

Provides struct and type for a OrganizationDetails

Provides struct and type for a OrganizationDisputeSettings

Provides struct and type for a OrganizationDisputeSettingsUpdate

Provides struct and type for a OrganizationFeatureSettings

Provides struct and type for a OrganizationFeatureSettingsUpdate

Provides struct and type for a OrganizationNotReadyForPayments

Provides struct and type for a OrganizationNotificationSettings

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 PauseResumeNotAllowed

Provides struct and type for a PaymentActionRequired

Provides struct and type for a PaymentAlreadyInProgress

Provides struct and type for a PaymentError

Provides struct and type for a PaymentFailed

Provides struct and type for a PaymentMethodCard

Provides struct and type for a PaymentMethodCardMetadata

Provides struct and type for a PaymentMethodGeneric

Provides struct and type for a PaymentMethodInUseByActiveSubscription

Provides struct and type for a PaymentMethodRequired

Provides struct and type for a PaymentMethodSetupFailed

Provides struct and type for a PaymentNotReady

Provides API endpoints related to payments

Provides struct and type for a PendingSubscriptionUpdate

Provides struct and type for a PortalAuthenticatedUser

Provides struct and type for a Product

Provides struct and type for a ProductBenefitsUpdate

Provides struct and type for a ProductCreateOneTime

Provides struct and type for a ProductCreateRecurring

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 ProductPriceSeatBasedCreate

Provides struct and type for a ProductPriceSeatTier

Provides struct and type for a ProductPriceSeatTiersInput

Provides struct and type for a ProductUpdate

Provides API endpoints related to products

Provides struct and type for a PropertyAggregation

Provides API endpoints related to public

Provides struct and type for a RefreshTokenRequest

Provides struct and type for a Refund

Provides struct and type for a RefundCreate

Provides struct and type for a RefundDispute

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 SSOEnforcementRequiresConnection

Provides struct and type for a SeatAssign

Provides struct and type for a SeatClaim

Provides struct and type for a SeatClaimInfo

Provides API endpoints related to seats

Provides struct and type for a SeatsList

Provides struct and type for a Subscription

Provides struct and type for a SubscriptionCancel

Provides struct and type for a SubscriptionCreateCustomer

Provides struct and type for a SubscriptionCreateExternalCustomer

Provides struct and type for a SubscriptionCustomer

Provides struct and type for a SubscriptionLocked

Provides struct and type for a SubscriptionMeter

Provides struct and type for a SubscriptionPause

Provides struct and type for a SubscriptionResume

Provides struct and type for a SubscriptionRevoke

Provides struct and type for a SubscriptionUpdateBase

Provides struct and type for a SubscriptionUpdateBillingPeriod

Provides struct and type for a SubscriptionUpdateClear

Provides struct and type for a SubscriptionUpdateDiscount

Provides struct and type for a SubscriptionUpdateProduct

Provides struct and type for a SubscriptionUpdateSeats

Provides struct and type for a SubscriptionUpdateTrial

Provides API endpoints related to subscriptions

This module is not automatically generated. It executes the requests described by the generated operation modules using Req, translating successful responses into their typed structs.

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 SupportCaseAttachmentFileCreate

Provides struct and type for a SupportCaseAttachmentFileRead

Provides struct and type for a TokenResponse

Provides struct and type for a TrialAlreadyRedeemed

Provides struct and type for a Unauthorized

Provides struct and type for a UniqueAggregation

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 API endpoints related to wallets

Provides struct and type for a WebTokenRequest

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