Skip to main content

CrystalDocs builds documentation for every shard, on request. The announcement: Documentation for every shard, on CrystalBits.

CrystalDocs

    Browse DocsCrystalShardsAbout

    github.com/Qard/polar-sh

    Types

    • Polar
      • Api
        • BenefitGrants
        • Benefits
        • CheckoutLinks
        • Checkouts
        • CustomFields
        • CustomerMeters
        • CustomerPortal
          • Base
          • BenefitGrants
          • CustomerMeters
          • CustomerSession
          • Customers
          • Downloadables
          • LicenseKeys
          • Orders
          • Organizations
          • Seats
          • Subscriptions
          • Wallets
        • CustomerSeats
        • CustomerSessions
        • Customers
        • Discounts
        • Events
        • Files
        • LicenseKeys
        • Meters
        • Metrics
        • Oauth2
          • Base
          • Clients
        • Orders
        • Organizations
        • Payments
        • Products
        • Refunds
        • Subscriptions
        • Wallets
        • Webhooks
      • BenefitGrantWebhook
      • Client
      • Generator
        • OperationContext
      • HTTPValidationError
      • Models
        • Address
        • AddressDict
        • AddressInput
        • Aggregation
        • AggregationFunction
        • AlreadyActiveSubscriptionError
        • AlreadyCanceledSubscription
        • AttachedCustomField
        • AttachedCustomFieldCreate
        • AuthorizationCodeTokenRequest
        • AuthorizeOrganization
        • AuthorizeResponseOrganization
        • AuthorizeResponseUser
        • AuthorizeUser
        • Benefit
        • BenefitCreate
        • BenefitCustom
        • BenefitCustomCreate
        • BenefitCustomCreateProperties
        • BenefitCustomProperties
        • BenefitCustomSubscriber
        • BenefitCustomSubscriberProperties
        • BenefitCustomUpdate
        • BenefitDiscord
        • BenefitDiscordCreate
        • BenefitDiscordCreateProperties
        • BenefitDiscordProperties
        • BenefitDiscordSubscriber
        • BenefitDiscordSubscriberProperties
        • BenefitDiscordUpdate
        • BenefitDownloadables
        • BenefitDownloadablesCreate
        • BenefitDownloadablesCreateProperties
        • BenefitDownloadablesProperties
        • BenefitDownloadablesSubscriber
        • BenefitDownloadablesSubscriberProperties
        • BenefitDownloadablesUpdate
        • BenefitGitHubRepository
        • BenefitGitHubRepositoryCreate
        • BenefitGitHubRepositoryCreateProperties
        • BenefitGitHubRepositoryProperties
        • BenefitGitHubRepositorySubscriber
        • BenefitGitHubRepositorySubscriberProperties
        • BenefitGitHubRepositoryUpdate
        • BenefitGrant
        • BenefitGrantCustomProperties
        • BenefitGrantDiscordProperties
        • BenefitGrantDownloadablesProperties
        • BenefitGrantError
        • BenefitGrantGitHubRepositoryProperties
        • BenefitGrantLicenseKeysProperties
        • BenefitGrantMetadata
        • BenefitGrantMeterCreditProperties
        • BenefitGrantSortProperty
        • BenefitLicenseKeyActivationCreateProperties
        • BenefitLicenseKeyActivationProperties
        • BenefitLicenseKeyExpirationProperties
        • BenefitLicenseKeys
        • BenefitLicenseKeysCreate
        • BenefitLicenseKeysCreateProperties
        • BenefitLicenseKeysProperties
        • BenefitLicenseKeysSubscriber
        • BenefitLicenseKeysSubscriberProperties
        • BenefitLicenseKeysUpdate
        • BenefitMeterCredit
        • BenefitMeterCreditCreate
        • BenefitMeterCreditCreateProperties
        • BenefitMeterCreditProperties
        • BenefitMeterCreditSubscriber
        • BenefitMeterCreditSubscriberProperties
        • BenefitMeterCreditUpdate
        • BenefitPublic
        • BenefitSortProperty
        • BenefitType
        • BillingAddressFieldMode
        • CardPayment
        • CardPaymentMetadata
        • Checkout
        • CheckoutBillingAddressFields
        • CheckoutConfirmStripe
        • CheckoutCreate
        • CheckoutCustomerBillingAddressFields
        • CheckoutDiscountFixedOnceForeverDuration
        • CheckoutDiscountFixedRepeatDuration
        • CheckoutDiscountPercentageOnceForeverDuration
        • CheckoutDiscountPercentageRepeatDuration
        • CheckoutForbiddenError
        • CheckoutLink
        • CheckoutLinkCreate
        • CheckoutLinkCreateProduct
        • CheckoutLinkCreateProductPrice
        • CheckoutLinkCreateProducts
        • CheckoutLinkDiscount
        • CheckoutLinkProduct
        • CheckoutLinkSortProperty
        • CheckoutLinkUpdate
        • CheckoutPriceCreate
        • CheckoutProduct
        • CheckoutProductCreate
        • CheckoutProductsCreate
        • CheckoutPublic
        • CheckoutPublicConfirmed
        • CheckoutSortProperty
        • CheckoutStatus
        • CheckoutUpdate
        • CheckoutUpdatePublic
        • CostMetadataInput
        • CostMetadataOutput
        • CountAggregation
        • CountryAlpha2
        • CountryAlpha2Input
        • CustomField
        • CustomFieldCheckbox
        • CustomFieldCheckboxProperties
        • CustomFieldCreate
        • CustomFieldCreateCheckbox
        • CustomFieldCreateDate
        • CustomFieldCreateNumber
        • CustomFieldCreateSelect
        • CustomFieldCreateText
        • CustomFieldDate
        • CustomFieldDateProperties
        • CustomFieldNumber
        • CustomFieldNumberProperties
        • CustomFieldSelect
        • CustomFieldSelectOption
        • CustomFieldSelectProperties
        • CustomFieldSortProperty
        • CustomFieldText
        • CustomFieldTextProperties
        • CustomFieldType
        • CustomFieldUpdate
        • CustomFieldUpdateCheckbox
        • CustomFieldUpdateDate
        • CustomFieldUpdateNumber
        • CustomFieldUpdateSelect
        • CustomFieldUpdateText
        • Customer
        • CustomerBalance
        • CustomerBenefitGrant
        • CustomerBenefitGrantCustom
        • CustomerBenefitGrantCustomUpdate
        • CustomerBenefitGrantDiscord
        • CustomerBenefitGrantDiscordPropertiesUpdate
        • CustomerBenefitGrantDiscordUpdate
        • CustomerBenefitGrantDownloadables
        • CustomerBenefitGrantDownloadablesUpdate
        • CustomerBenefitGrantGitHubRepository
        • CustomerBenefitGrantGitHubRepositoryPropertiesUpdate
        • CustomerBenefitGrantGitHubRepositoryUpdate
        • CustomerBenefitGrantLicenseKeys
        • CustomerBenefitGrantLicenseKeysUpdate
        • CustomerBenefitGrantMeterCredit
        • CustomerBenefitGrantMeterCreditUpdate
        • CustomerBenefitGrantSortProperty
        • CustomerBenefitGrantUpdate
        • CustomerCancellationReason
        • CustomerCreate
        • CustomerCreatedMetadata
        • CustomerCustomerMeter
        • CustomerCustomerMeterMeter
        • CustomerCustomerMeterSortProperty
        • CustomerCustomerSession
        • CustomerDeletedMetadata
        • CustomerMeter
        • CustomerMeterSortProperty
        • CustomerNotReady
        • CustomerOrder
        • CustomerOrderConfirmPayment
        • CustomerOrderInvoice
        • CustomerOrderPaymentConfirmation
        • CustomerOrderPaymentStatus
        • CustomerOrderProduct
        • CustomerOrderSortProperty
        • CustomerOrderSubscription
        • CustomerOrderUpdate
        • CustomerOrganization
        • CustomerPaymentMethod
        • CustomerPaymentMethodConfirm
        • CustomerPaymentMethodCreate
        • CustomerPaymentMethodCreateRequiresActionResponse
        • CustomerPaymentMethodCreateResponse
        • CustomerPaymentMethodCreateSucceededResponse
        • CustomerPortalCustomer
        • CustomerPortalCustomerUpdate
        • CustomerPortalOAuthAccount
        • CustomerProduct
        • CustomerSeat
        • CustomerSeatClaimResponse
        • CustomerSession
        • CustomerSessionCustomerExternalIDCreate
        • CustomerSessionCustomerIDCreate
        • CustomerSortProperty
        • CustomerState
        • CustomerStateBenefitGrant
        • CustomerStateMeter
        • CustomerStateSubscription
        • CustomerStateSubscriptionMeter
        • CustomerSubscription
        • CustomerSubscriptionCancel
        • CustomerSubscriptionMeter
        • CustomerSubscriptionMeterMeter
        • CustomerSubscriptionProduct
        • CustomerSubscriptionSortProperty
        • CustomerSubscriptionUpdate
        • CustomerSubscriptionUpdateProduct
        • CustomerSubscriptionUpdateSeats
        • CustomerUpdate
        • CustomerUpdateExternalID
        • CustomerUpdatedFields
        • CustomerUpdatedMetadata
        • CustomerWallet
        • CustomerWalletSortProperty
        • Discount
        • DiscountCreate
        • DiscountDuration
        • DiscountFixedOnceForeverDuration
        • DiscountFixedOnceForeverDurationBase
        • DiscountFixedOnceForeverDurationCreate
        • DiscountFixedRepeatDuration
        • DiscountFixedRepeatDurationBase
        • DiscountFixedRepeatDurationCreate
        • DiscountPercentageOnceForeverDuration
        • DiscountPercentageOnceForeverDurationBase
        • DiscountPercentageOnceForeverDurationCreate
        • DiscountPercentageRepeatDuration
        • DiscountPercentageRepeatDurationBase
        • DiscountPercentageRepeatDurationCreate
        • DiscountProduct
        • DiscountSortProperty
        • DiscountType
        • DiscountUpdate
        • DownloadableFileCreate
        • DownloadableFileRead
        • DownloadableRead
        • Event
        • EventCreateCustomer
        • EventCreateExternalCustomer
        • EventMetadataInput
        • EventMetadataOutput
        • EventName
        • EventNamesSortProperty
        • EventSortProperty
        • EventSource
        • EventsIngest
        • EventsIngestResponse
        • ExistingProductPrice
        • ExpiredCheckoutError
        • FileCreate
        • FileDownload
        • FilePatch
        • FileRead
        • FileServiceTypes
        • FileUpload
        • FileUploadCompleted
        • Filter
        • FilterClause
        • FilterConjunction
        • FilterOperator
        • GenericPayment
        • IntrospectTokenRequest
        • IntrospectTokenResponse
        • LLMMetadata
        • LegacyRecurringProductPrice
        • LegacyRecurringProductPriceCustom
        • LegacyRecurringProductPriceFixed
        • LegacyRecurringProductPriceFree
        • LicenseKeyActivate
        • LicenseKeyActivationBase
        • LicenseKeyActivationRead
        • LicenseKeyCustomer
        • LicenseKeyDeactivate
        • LicenseKeyRead
        • LicenseKeyStatus
        • LicenseKeyUpdate
        • LicenseKeyUser
        • LicenseKeyValidate
        • LicenseKeyWithActivations
        • ListResource
        • Meter
        • MeterCreate
        • MeterCreditedMetadata
        • MeterQuantities
        • MeterQuantity
        • MeterResetMetadata
        • MeterSortProperty
        • MeterUpdate
        • Metric
        • MetricPeriod
        • MetricType
        • Metrics
        • MetricsIntervalLimit
        • MetricsIntervalsLimits
        • MetricsLimits
        • MetricsResponse
        • MetricsTotals
        • MissingInvoiceBillingDetails
        • MissingPaymentMethodError
        • NotOpenCheckout
        • NotPaidOrder
        • OAuth2ClientConfiguration
        • OAuth2ClientConfigurationUpdate
        • OAuth2ClientPublic
        • Order
        • OrderBillingReason
        • OrderBillingReasonInternal
        • OrderCustomer
        • OrderDiscount
        • OrderInvoice
        • OrderItemSchema
        • OrderNotEligibleForRetry
        • OrderPaidMetadata
        • OrderProduct
        • OrderRefundedMetadata
        • OrderSortProperty
        • OrderStatus
        • OrderSubscription
        • OrderUpdate
        • OrderUser
        • Organization
        • OrganizationAvatarFileCreate
        • OrganizationAvatarFileRead
        • OrganizationCreate
        • OrganizationCustomerEmailSettings
        • OrganizationDetails
        • OrganizationFeatureSettings
        • OrganizationNotificationSettings
        • OrganizationProfileSettings
        • OrganizationSocialLink
        • OrganizationSocialPlatforms
        • OrganizationSortProperty
        • OrganizationStatus
        • OrganizationSubscribePromoteSettings
        • OrganizationSubscriptionSettings
        • OrganizationUpdate
        • Pagination
        • Payment
        • PaymentAlreadyInProgress
        • PaymentError
        • PaymentIntentFailedError
        • PaymentMethodCard
        • PaymentMethodCardMetadata
        • PaymentMethodGeneric
        • PaymentMethodInUseByActiveSubscription
        • PaymentNotReady
        • PaymentProcessor
        • PaymentSortProperty
        • PaymentStatus
        • Product
        • ProductBenefitsUpdate
        • ProductBillingType
        • ProductCreate
        • ProductCreateOneTime
        • ProductCreateRecurring
        • ProductMediaFileCreate
        • ProductMediaFileRead
        • ProductPrice
        • ProductPriceCustom
        • ProductPriceCustomCreate
        • ProductPriceFixed
        • ProductPriceFixedCreate
        • ProductPriceFree
        • ProductPriceFreeCreate
        • ProductPriceMeter
        • ProductPriceMeteredUnit
        • ProductPriceMeteredUnitCreate
        • ProductPriceSeatBased
        • ProductPriceSeatBasedCreate
        • ProductPriceSeatTier
        • ProductPriceSeatTiers
        • ProductPriceType
        • ProductSortProperty
        • ProductUpdate
        • Properties
        • PropertyAggregation
        • RefreshTokenRequest
        • Refund
        • RefundAmountTooHigh
        • RefundCreate
        • RefundReason
        • RefundSortProperty
        • RefundStatus
        • RefundedAlready
        • RevokeTokenRequest
        • RevokeTokenResponse
        • S3DownloadURL
        • S3FileCreateMultipart
        • S3FileCreatePart
        • S3FileUploadCompletedPart
        • S3FileUploadMultipart
        • S3FileUploadPart
        • Scope
        • SeatAssign
        • SeatClaim
        • SeatClaimInfo
        • SeatStatus
        • SeatsList
        • SubType
        • Subscription
        • SubscriptionCancel
        • SubscriptionCreateCustomer
        • SubscriptionCreateExternalCustomer
        • SubscriptionCustomer
        • SubscriptionCycledMetadata
        • SubscriptionDiscount
        • SubscriptionLocked
        • SubscriptionMeter
        • SubscriptionProductUpdatedMetadata
        • SubscriptionProrationBehavior
        • SubscriptionRecurringInterval
        • SubscriptionRevoke
        • SubscriptionRevokedMetadata
        • SubscriptionSortProperty
        • SubscriptionStatus
        • SubscriptionUpdate
        • SubscriptionUpdateDiscount
        • SubscriptionUpdateProduct
        • SubscriptionUpdateSeats
        • SubscriptionUpdateTrial
        • SubscriptionUser
        • SystemEvent
        • TaxIDFormat
        • TimeInterval
        • TokenResponse
        • TrialInterval
        • UniqueAggregation
        • UserEvent
        • UserInfoOrganization
        • UserInfoUser
        • ValidatedLicenseKey
        • ValidationError
        • Wallet
        • WalletSortProperty
        • WalletTopUpCreate
        • WebTokenRequest
        • WebhookDelivery
        • WebhookEndpoint
        • WebhookEndpointCreate
        • WebhookEndpointUpdate
        • WebhookEvent
        • WebhookEventType
        • WebhookFormat
      • NotPermittedError
      • PaginatedIterator
      • PolarError
      • ResourceNotFoundError
      • WebhookPayload
      • WebhookVerificationError
      • Webhooks
    • SchemaType
    module

    Polar::Api

    Nested types

    • Polar::Api::BenefitGrants
    • Polar::Api::Benefits
    • Polar::Api::CheckoutLinks
    • Polar::Api::Checkouts
    • Polar::Api::CustomFields
    • Polar::Api::CustomerMeters
    • Polar::Api::CustomerPortal
    • Polar::Api::CustomerSeats
    • Polar::Api::CustomerSessions
    • Polar::Api::Customers
    • Polar::Api::Discounts
    • Polar::Api::Events
    • Polar::Api::Files
    • Polar::Api::LicenseKeys
    • Polar::Api::Meters
    • Polar::Api::Metrics
    • Polar::Api::Oauth2
    • Polar::Api::Orders
    • Polar::Api::Organizations
    • Polar::Api::Payments
    • Polar::Api::Products
    • Polar::Api::Refunds
    • Polar::Api::Subscriptions
    • Polar::Api::Wallets
    • Polar::Api::Webhooks

    Advertisement

    Crystal jobs from CrystalGigs

    • Your posting here

      Reach Crystal developers on CrystalGigsFirst party

    CrystalDocs.org - Crystal Shard Documentation Hosting

    The CrystalBits newsletter

    Crystal tutorials, release news and community writing. One email when there is something new, never a stream.

    You will get one confirmation email to check the address is yours. Unsubscribe any time.

    GitHubCrystalShardsCrystalGigsCrystalBitsCrystal LanguageStatsSponsor

    The Bushido Collective builds and maintains this site.
    Licensed under the Apache License 2.0