├── .gitattributes ├── .github └── workflows │ ├── sdk_generation.yaml │ └── sdk_publish.yaml ├── .gitignore ├── .speakeasy ├── gen.lock ├── gen.yaml ├── workflow.lock └── workflow.yaml ├── CONTRIBUTING.md ├── README.md ├── RELEASES.md ├── USAGE.md ├── composer.json ├── config └── services.php ├── docs ├── Models │ ├── Components │ │ ├── ActiveSubscriptions.md │ │ ├── Address.md │ │ ├── Aggregation.md │ │ ├── AttachedCustomField.md │ │ ├── AttachedCustomFieldCreate.md │ │ ├── AuthorizationCodeTokenRequest.md │ │ ├── AuthorizeOrganization.md │ │ ├── AuthorizeResponseOrganization.md │ │ ├── AuthorizeResponseUser.md │ │ ├── AuthorizeUser.md │ │ ├── AverageOrderValue.md │ │ ├── Benefit.md │ │ ├── BenefitCreate.md │ │ ├── BenefitCustom.md │ │ ├── BenefitCustomCreate.md │ │ ├── BenefitCustomCreateMetadata.md │ │ ├── BenefitCustomCreateProperties.md │ │ ├── BenefitCustomMetadata.md │ │ ├── BenefitCustomProperties.md │ │ ├── BenefitCustomSubscriber.md │ │ ├── BenefitCustomSubscriberMetadata.md │ │ ├── BenefitCustomSubscriberProperties.md │ │ ├── BenefitCustomUpdate.md │ │ ├── BenefitCustomUpdateMetadata.md │ │ ├── BenefitCycledEvent.md │ │ ├── BenefitDiscord.md │ │ ├── BenefitDiscordCreate.md │ │ ├── BenefitDiscordCreateMetadata.md │ │ ├── BenefitDiscordCreateProperties.md │ │ ├── BenefitDiscordMetadata.md │ │ ├── BenefitDiscordProperties.md │ │ ├── BenefitDiscordSubscriber.md │ │ ├── BenefitDiscordSubscriberMetadata.md │ │ ├── BenefitDiscordSubscriberProperties.md │ │ ├── BenefitDiscordUpdate.md │ │ ├── BenefitDiscordUpdateMetadata.md │ │ ├── BenefitDownloadables.md │ │ ├── BenefitDownloadablesCreate.md │ │ ├── BenefitDownloadablesCreateMetadata.md │ │ ├── BenefitDownloadablesCreateProperties.md │ │ ├── BenefitDownloadablesMetadata.md │ │ ├── BenefitDownloadablesProperties.md │ │ ├── BenefitDownloadablesSubscriber.md │ │ ├── BenefitDownloadablesSubscriberMetadata.md │ │ ├── BenefitDownloadablesSubscriberProperties.md │ │ ├── BenefitDownloadablesUpdate.md │ │ ├── BenefitDownloadablesUpdateMetadata.md │ │ ├── BenefitGitHubRepository.md │ │ ├── BenefitGitHubRepositoryCreate.md │ │ ├── BenefitGitHubRepositoryCreateMetadata.md │ │ ├── BenefitGitHubRepositoryCreateProperties.md │ │ ├── BenefitGitHubRepositoryCreatePropertiesPermission.md │ │ ├── BenefitGitHubRepositoryMetadata.md │ │ ├── BenefitGitHubRepositoryProperties.md │ │ ├── BenefitGitHubRepositorySubscriber.md │ │ ├── BenefitGitHubRepositorySubscriberMetadata.md │ │ ├── BenefitGitHubRepositorySubscriberProperties.md │ │ ├── BenefitGitHubRepositoryUpdate.md │ │ ├── BenefitGitHubRepositoryUpdateMetadata.md │ │ ├── BenefitGrant.md │ │ ├── BenefitGrantCustomProperties.md │ │ ├── BenefitGrantDiscordProperties.md │ │ ├── BenefitGrantDownloadablesProperties.md │ │ ├── BenefitGrantError.md │ │ ├── BenefitGrantGitHubRepositoryProperties.md │ │ ├── BenefitGrantGitHubRepositoryPropertiesPermission.md │ │ ├── BenefitGrantLicenseKeysProperties.md │ │ ├── BenefitGrantMetadata.md │ │ ├── BenefitGrantMeterCreditProperties.md │ │ ├── BenefitGrantWebhook.md │ │ ├── BenefitGrantWebhookProperties.md │ │ ├── BenefitGrantedEvent.md │ │ ├── BenefitLicenseKeyActivationCreateProperties.md │ │ ├── BenefitLicenseKeyActivationProperties.md │ │ ├── BenefitLicenseKeyExpirationProperties.md │ │ ├── BenefitLicenseKeys.md │ │ ├── BenefitLicenseKeysCreate.md │ │ ├── BenefitLicenseKeysCreateMetadata.md │ │ ├── BenefitLicenseKeysCreateProperties.md │ │ ├── BenefitLicenseKeysMetadata.md │ │ ├── BenefitLicenseKeysProperties.md │ │ ├── BenefitLicenseKeysSubscriber.md │ │ ├── BenefitLicenseKeysSubscriberMetadata.md │ │ ├── BenefitLicenseKeysSubscriberProperties.md │ │ ├── BenefitLicenseKeysUpdate.md │ │ ├── BenefitLicenseKeysUpdateMetadata.md │ │ ├── BenefitMeterCredit.md │ │ ├── BenefitMeterCreditCreate.md │ │ ├── BenefitMeterCreditCreateMetadata.md │ │ ├── BenefitMeterCreditCreateProperties.md │ │ ├── BenefitMeterCreditMetadata.md │ │ ├── BenefitMeterCreditProperties.md │ │ ├── BenefitMeterCreditSubscriber.md │ │ ├── BenefitMeterCreditSubscriberMetadata.md │ │ ├── BenefitMeterCreditSubscriberProperties.md │ │ ├── BenefitMeterCreditUpdate.md │ │ ├── BenefitMeterCreditUpdateMetadata.md │ │ ├── BenefitPublic.md │ │ ├── BenefitRevokedEvent.md │ │ ├── BenefitSortProperty.md │ │ ├── BenefitType.md │ │ ├── BenefitUpdatedEvent.md │ │ ├── CardPayment.md │ │ ├── CardPaymentMetadata.md │ │ ├── Checkout.md │ │ ├── CheckoutConfirmStripe.md │ │ ├── CheckoutConfirmStripeCustomFieldData.md │ │ ├── CheckoutCreate.md │ │ ├── CheckoutCreateCustomFieldData.md │ │ ├── CheckoutCreateCustomerMetadata.md │ │ ├── CheckoutCreateMetadata.md │ │ ├── CheckoutCustomFieldData.md │ │ ├── CheckoutCustomerBillingAddressFields.md │ │ ├── CheckoutDiscount.md │ │ ├── CheckoutDiscountFixedOnceForeverDuration.md │ │ ├── CheckoutDiscountFixedRepeatDuration.md │ │ ├── CheckoutDiscountPercentageOnceForeverDuration.md │ │ ├── CheckoutDiscountPercentageRepeatDuration.md │ │ ├── CheckoutLink.md │ │ ├── CheckoutLinkCreateProduct.md │ │ ├── CheckoutLinkCreateProductMetadata.md │ │ ├── CheckoutLinkCreateProductPrice.md │ │ ├── CheckoutLinkCreateProductPriceMetadata.md │ │ ├── CheckoutLinkCreateProducts.md │ │ ├── CheckoutLinkCreateProductsMetadata.md │ │ ├── CheckoutLinkDiscount.md │ │ ├── CheckoutLinkMetadata.md │ │ ├── CheckoutLinkProduct.md │ │ ├── CheckoutLinkProductMetadata.md │ │ ├── CheckoutLinkProductPrices.md │ │ ├── CheckoutLinkSortProperty.md │ │ ├── CheckoutLinkUpdate.md │ │ ├── CheckoutLinkUpdateMetadata.md │ │ ├── CheckoutMetadata.md │ │ ├── CheckoutProduct.md │ │ ├── CheckoutProductPrice.md │ │ ├── CheckoutProductPrices.md │ │ ├── CheckoutPublic.md │ │ ├── CheckoutPublicConfirmed.md │ │ ├── CheckoutPublicConfirmedCustomFieldData.md │ │ ├── CheckoutPublicConfirmedDiscount.md │ │ ├── CheckoutPublicConfirmedProductPrice.md │ │ ├── CheckoutPublicCustomFieldData.md │ │ ├── CheckoutPublicDiscount.md │ │ ├── CheckoutPublicProductPrice.md │ │ ├── CheckoutSortProperty.md │ │ ├── CheckoutStatus.md │ │ ├── CheckoutUpdate.md │ │ ├── CheckoutUpdateCustomFieldData.md │ │ ├── CheckoutUpdateCustomerMetadata.md │ │ ├── CheckoutUpdateMetadata.md │ │ ├── CheckoutUpdatePublic.md │ │ ├── CheckoutUpdatePublicCustomFieldData.md │ │ ├── Checkouts.md │ │ ├── CheckoutsConversion.md │ │ ├── Clauses.md │ │ ├── Conditions.md │ │ ├── CountAggregation.md │ │ ├── CumulativeRevenue.md │ │ ├── CustomField.md │ │ ├── CustomFieldCheckbox.md │ │ ├── CustomFieldCheckboxMetadata.md │ │ ├── CustomFieldCheckboxProperties.md │ │ ├── CustomFieldCreate.md │ │ ├── CustomFieldCreateCheckbox.md │ │ ├── CustomFieldCreateCheckboxMetadata.md │ │ ├── CustomFieldCreateDate.md │ │ ├── CustomFieldCreateDateMetadata.md │ │ ├── CustomFieldCreateNumber.md │ │ ├── CustomFieldCreateNumberMetadata.md │ │ ├── CustomFieldCreateSelect.md │ │ ├── CustomFieldCreateSelectMetadata.md │ │ ├── CustomFieldCreateText.md │ │ ├── CustomFieldCreateTextMetadata.md │ │ ├── CustomFieldData.md │ │ ├── CustomFieldDate.md │ │ ├── CustomFieldDateMetadata.md │ │ ├── CustomFieldDateProperties.md │ │ ├── CustomFieldNumber.md │ │ ├── CustomFieldNumberMetadata.md │ │ ├── CustomFieldNumberProperties.md │ │ ├── CustomFieldSelect.md │ │ ├── CustomFieldSelectMetadata.md │ │ ├── CustomFieldSelectOption.md │ │ ├── CustomFieldSelectProperties.md │ │ ├── CustomFieldSortProperty.md │ │ ├── CustomFieldText.md │ │ ├── CustomFieldTextMetadata.md │ │ ├── CustomFieldTextProperties.md │ │ ├── CustomFieldType.md │ │ ├── CustomFieldUpdate.md │ │ ├── CustomFieldUpdateCheckbox.md │ │ ├── CustomFieldUpdateCheckboxMetadata.md │ │ ├── CustomFieldUpdateDate.md │ │ ├── CustomFieldUpdateDateMetadata.md │ │ ├── CustomFieldUpdateNumber.md │ │ ├── CustomFieldUpdateNumberMetadata.md │ │ ├── CustomFieldUpdateSelect.md │ │ ├── CustomFieldUpdateSelectMetadata.md │ │ ├── CustomFieldUpdateText.md │ │ ├── CustomFieldUpdateTextMetadata.md │ │ ├── Customer.md │ │ ├── CustomerBenefitGrant.md │ │ ├── CustomerBenefitGrantCustom.md │ │ ├── CustomerBenefitGrantCustomUpdate.md │ │ ├── CustomerBenefitGrantDiscord.md │ │ ├── CustomerBenefitGrantDiscordPropertiesUpdate.md │ │ ├── CustomerBenefitGrantDiscordUpdate.md │ │ ├── CustomerBenefitGrantDownloadables.md │ │ ├── CustomerBenefitGrantDownloadablesUpdate.md │ │ ├── CustomerBenefitGrantGitHubRepository.md │ │ ├── CustomerBenefitGrantGitHubRepositoryPropertiesUpdate.md │ │ ├── CustomerBenefitGrantGitHubRepositoryUpdate.md │ │ ├── CustomerBenefitGrantLicenseKeys.md │ │ ├── CustomerBenefitGrantLicenseKeysUpdate.md │ │ ├── CustomerBenefitGrantMeterCredit.md │ │ ├── CustomerBenefitGrantMeterCreditUpdate.md │ │ ├── CustomerBenefitGrantSortProperty.md │ │ ├── CustomerBenefitGrantUpdate.md │ │ ├── CustomerCancellationReason.md │ │ ├── CustomerCreate.md │ │ ├── CustomerCreateMetadata.md │ │ ├── CustomerCreateTaxId.md │ │ ├── CustomerCustomerMeter.md │ │ ├── CustomerCustomerMeterMeter.md │ │ ├── CustomerCustomerMeterSortProperty.md │ │ ├── CustomerMetadata.md │ │ ├── CustomerMetadata1.md │ │ ├── CustomerMeter.md │ │ ├── CustomerMeterSortProperty.md │ │ ├── CustomerOrder.md │ │ ├── CustomerOrderInvoice.md │ │ ├── CustomerOrderProduct.md │ │ ├── CustomerOrderProductPrices.md │ │ ├── CustomerOrderSortProperty.md │ │ ├── CustomerOrderSubscription.md │ │ ├── CustomerOrderUpdate.md │ │ ├── CustomerOrganization.md │ │ ├── CustomerPaymentMethodCreate.md │ │ ├── CustomerPortalCustomer.md │ │ ├── CustomerPortalCustomerTaxId.md │ │ ├── CustomerPortalCustomerUpdate.md │ │ ├── CustomerPortalOAuthAccount.md │ │ ├── CustomerProduct.md │ │ ├── CustomerProductPrices.md │ │ ├── CustomerSession.md │ │ ├── CustomerSessionCustomerExternalIDCreate.md │ │ ├── CustomerSessionCustomerIDCreate.md │ │ ├── CustomerSortProperty.md │ │ ├── CustomerState.md │ │ ├── CustomerStateBenefitGrant.md │ │ ├── CustomerStateBenefitGrantProperties.md │ │ ├── CustomerStateMetadata.md │ │ ├── CustomerStateMeter.md │ │ ├── CustomerStateSubscription.md │ │ ├── CustomerStateSubscriptionCustomFieldData.md │ │ ├── CustomerStateSubscriptionMetadata.md │ │ ├── CustomerStateSubscriptionMeter.md │ │ ├── CustomerStateTaxId.md │ │ ├── CustomerSubscription.md │ │ ├── CustomerSubscriptionCancel.md │ │ ├── CustomerSubscriptionMeter.md │ │ ├── CustomerSubscriptionMeterMeter.md │ │ ├── CustomerSubscriptionPrices.md │ │ ├── CustomerSubscriptionProduct.md │ │ ├── CustomerSubscriptionProductPrices.md │ │ ├── CustomerSubscriptionSortProperty.md │ │ ├── CustomerSubscriptionUpdate.md │ │ ├── CustomerSubscriptionUpdateProduct.md │ │ ├── CustomerTaxId.md │ │ ├── CustomerUpdate.md │ │ ├── CustomerUpdateExternalID.md │ │ ├── CustomerUpdateExternalIDMetadata.md │ │ ├── CustomerUpdateExternalIDTaxID.md │ │ ├── CustomerUpdateMetadata.md │ │ ├── CustomerUpdateTaxId.md │ │ ├── Discount.md │ │ ├── DiscountCreate.md │ │ ├── DiscountDuration.md │ │ ├── DiscountFixedOnceForeverDuration.md │ │ ├── DiscountFixedOnceForeverDurationBase.md │ │ ├── DiscountFixedOnceForeverDurationBaseMetadata.md │ │ ├── DiscountFixedOnceForeverDurationCreate.md │ │ ├── DiscountFixedOnceForeverDurationCreateMetadata.md │ │ ├── DiscountFixedOnceForeverDurationMetadata.md │ │ ├── DiscountFixedRepeatDuration.md │ │ ├── DiscountFixedRepeatDurationBase.md │ │ ├── DiscountFixedRepeatDurationBaseMetadata.md │ │ ├── DiscountFixedRepeatDurationCreate.md │ │ ├── DiscountFixedRepeatDurationCreateMetadata.md │ │ ├── DiscountFixedRepeatDurationMetadata.md │ │ ├── DiscountPercentageOnceForeverDuration.md │ │ ├── DiscountPercentageOnceForeverDurationBase.md │ │ ├── DiscountPercentageOnceForeverDurationBaseMetadata.md │ │ ├── DiscountPercentageOnceForeverDurationCreate.md │ │ ├── DiscountPercentageOnceForeverDurationCreateMetadata.md │ │ ├── DiscountPercentageOnceForeverDurationMetadata.md │ │ ├── DiscountPercentageRepeatDuration.md │ │ ├── DiscountPercentageRepeatDurationBase.md │ │ ├── DiscountPercentageRepeatDurationBaseMetadata.md │ │ ├── DiscountPercentageRepeatDurationCreate.md │ │ ├── DiscountPercentageRepeatDurationCreateMetadata.md │ │ ├── DiscountPercentageRepeatDurationMetadata.md │ │ ├── DiscountProduct.md │ │ ├── DiscountProductMetadata.md │ │ ├── DiscountSortProperty.md │ │ ├── DiscountType.md │ │ ├── DiscountUpdate.md │ │ ├── DiscountUpdateMetadata.md │ │ ├── DownloadableFileCreate.md │ │ ├── DownloadableFileRead.md │ │ ├── DownloadableRead.md │ │ ├── Event.md │ │ ├── EventCreateCustomer.md │ │ ├── EventCreateCustomerMetadata.md │ │ ├── EventCreateExternalCustomer.md │ │ ├── EventCreateExternalCustomerMetadata.md │ │ ├── EventName.md │ │ ├── EventNamesSortProperty.md │ │ ├── EventSortProperty.md │ │ ├── EventSource.md │ │ ├── Events.md │ │ ├── EventsIngest.md │ │ ├── EventsIngestResponse.md │ │ ├── ExistingProductPrice.md │ │ ├── FileCreate.md │ │ ├── FileDownload.md │ │ ├── FilePatch.md │ │ ├── FileRead.md │ │ ├── FileServiceTypes.md │ │ ├── FileUpload.md │ │ ├── FileUploadCompleted.md │ │ ├── Filter.md │ │ ├── FilterClause.md │ │ ├── FilterConjunction.md │ │ ├── FilterOperator.md │ │ ├── Func.md │ │ ├── GenericPayment.md │ │ ├── GrantTypes.md │ │ ├── IntrospectTokenRequest.md │ │ ├── IntrospectTokenRequestTokenTypeHint.md │ │ ├── IntrospectTokenResponse.md │ │ ├── Items.md │ │ ├── LegacyRecurringProductPrice.md │ │ ├── LegacyRecurringProductPriceCustom.md │ │ ├── LegacyRecurringProductPriceFixed.md │ │ ├── LegacyRecurringProductPriceFree.md │ │ ├── LicenseKeyActivate.md │ │ ├── LicenseKeyActivateConditions.md │ │ ├── LicenseKeyActivateMeta.md │ │ ├── LicenseKeyActivationBase.md │ │ ├── LicenseKeyActivationRead.md │ │ ├── LicenseKeyActivationReadMeta.md │ │ ├── LicenseKeyCustomer.md │ │ ├── LicenseKeyCustomerMetadata.md │ │ ├── LicenseKeyCustomerTaxId.md │ │ ├── LicenseKeyDeactivate.md │ │ ├── LicenseKeyRead.md │ │ ├── LicenseKeyStatus.md │ │ ├── LicenseKeyUpdate.md │ │ ├── LicenseKeyValidate.md │ │ ├── LicenseKeyWithActivations.md │ │ ├── ListResource.md │ │ ├── ListResourceBenefit.md │ │ ├── ListResourceBenefitGrant.md │ │ ├── ListResourceCheckout.md │ │ ├── ListResourceCheckoutLink.md │ │ ├── ListResourceCustomField.md │ │ ├── ListResourceCustomer.md │ │ ├── ListResourceCustomerBenefitGrant.md │ │ ├── ListResourceCustomerCustomerMeter.md │ │ ├── ListResourceCustomerMeter.md │ │ ├── ListResourceCustomerOrder.md │ │ ├── ListResourceCustomerSubscription.md │ │ ├── ListResourceDiscount.md │ │ ├── ListResourceDownloadableRead.md │ │ ├── ListResourceEvent.md │ │ ├── ListResourceEventName.md │ │ ├── ListResourceFileRead.md │ │ ├── ListResourceLicenseKeyRead.md │ │ ├── ListResourceMeter.md │ │ ├── ListResourceOAuth2Client.md │ │ ├── ListResourceOrder.md │ │ ├── ListResourceOrganization.md │ │ ├── ListResourceProduct.md │ │ ├── ListResourceRefund.md │ │ ├── ListResourceSubscription.md │ │ ├── ListResourceUnionPaymentMethodCardPaymentMethodGeneric.md │ │ ├── Loc.md │ │ ├── Meta.md │ │ ├── Metadata.md │ │ ├── MetadataQuery.md │ │ ├── Meter.md │ │ ├── MeterAggregation.md │ │ ├── MeterCreate.md │ │ ├── MeterCreateAggregation.md │ │ ├── MeterCreateMetadata.md │ │ ├── MeterCreditEvent.md │ │ ├── MeterCreditedMetadata.md │ │ ├── MeterMetadata.md │ │ ├── MeterQuantities.md │ │ ├── MeterQuantity.md │ │ ├── MeterResetEvent.md │ │ ├── MeterResetMetadata.md │ │ ├── MeterSortProperty.md │ │ ├── MeterUpdate.md │ │ ├── MeterUpdateMetadata.md │ │ ├── Metric.md │ │ ├── MetricPeriod.md │ │ ├── MetricType.md │ │ ├── Metrics.md │ │ ├── MetricsIntervalLimit.md │ │ ├── MetricsIntervalsLimits.md │ │ ├── MetricsLimits.md │ │ ├── MetricsResponse.md │ │ ├── MetricsTotals.md │ │ ├── MetricsTotalsActiveSubscriptions.md │ │ ├── MetricsTotalsAverageOrderValue.md │ │ ├── MetricsTotalsCheckouts.md │ │ ├── MetricsTotalsCheckoutsConversion.md │ │ ├── MetricsTotalsCumulativeRevenue.md │ │ ├── MetricsTotalsMonthlyRecurringRevenue.md │ │ ├── MetricsTotalsNewSubscriptions.md │ │ ├── MetricsTotalsNewSubscriptionsRevenue.md │ │ ├── MetricsTotalsOneTimeProducts.md │ │ ├── MetricsTotalsOneTimeProductsRevenue.md │ │ ├── MetricsTotalsOrders.md │ │ ├── MetricsTotalsRenewedSubscriptions.md │ │ ├── MetricsTotalsRenewedSubscriptionsRevenue.md │ │ ├── MetricsTotalsRevenue.md │ │ ├── MetricsTotalsSucceededCheckouts.md │ │ ├── MonthlyRecurringRevenue.md │ │ ├── NewSubscriptions.md │ │ ├── NewSubscriptionsRevenue.md │ │ ├── OAuth2Client.md │ │ ├── OAuth2ClientConfiguration.md │ │ ├── OAuth2ClientConfigurationGrantTypes.md │ │ ├── OAuth2ClientConfigurationTokenEndpointAuthMethod.md │ │ ├── OAuth2ClientConfigurationUpdate.md │ │ ├── OAuth2ClientConfigurationUpdateGrantTypes.md │ │ ├── OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod.md │ │ ├── OAuth2ClientPublic.md │ │ ├── OneTimeProducts.md │ │ ├── OneTimeProductsRevenue.md │ │ ├── Order.md │ │ ├── OrderBillingReason.md │ │ ├── OrderCustomFieldData.md │ │ ├── OrderCustomer.md │ │ ├── OrderCustomerMetadata.md │ │ ├── OrderCustomerTaxId.md │ │ ├── OrderDiscount.md │ │ ├── OrderInvoice.md │ │ ├── OrderItemSchema.md │ │ ├── OrderMetadata.md │ │ ├── OrderProduct.md │ │ ├── OrderProductMetadata.md │ │ ├── OrderSortProperty.md │ │ ├── OrderStatus.md │ │ ├── OrderSubscription.md │ │ ├── OrderSubscriptionMetadata.md │ │ ├── OrderUpdate.md │ │ ├── Orders.md │ │ ├── Organization.md │ │ ├── OrganizationAvatarFileCreate.md │ │ ├── OrganizationAvatarFileRead.md │ │ ├── OrganizationCreate.md │ │ ├── OrganizationDetails.md │ │ ├── OrganizationFeatureSettings.md │ │ ├── OrganizationSocialLink.md │ │ ├── OrganizationSocialPlatforms.md │ │ ├── OrganizationSortProperty.md │ │ ├── OrganizationSubscriptionSettings.md │ │ ├── OrganizationUpdate.md │ │ ├── Pagination.md │ │ ├── Payment.md │ │ ├── PaymentMethodCard.md │ │ ├── PaymentMethodCardData.md │ │ ├── PaymentMethodGeneric.md │ │ ├── PaymentProcessor.md │ │ ├── PaymentSortProperty.md │ │ ├── PaymentStatus.md │ │ ├── Permission.md │ │ ├── PreviousProperties.md │ │ ├── Prices.md │ │ ├── Product.md │ │ ├── ProductBenefitsUpdate.md │ │ ├── ProductBillingType.md │ │ ├── ProductCreate.md │ │ ├── ProductCreateMetadata.md │ │ ├── ProductCreatePrices.md │ │ ├── ProductMediaFileCreate.md │ │ ├── ProductMediaFileRead.md │ │ ├── ProductMetadata.md │ │ ├── ProductPrice.md │ │ ├── ProductPriceCustom.md │ │ ├── ProductPriceCustomCreate.md │ │ ├── ProductPriceFixed.md │ │ ├── ProductPriceFixedCreate.md │ │ ├── ProductPriceFree.md │ │ ├── ProductPriceFreeCreate.md │ │ ├── ProductPriceMeter.md │ │ ├── ProductPriceMeteredUnit.md │ │ ├── ProductPriceMeteredUnitCreate.md │ │ ├── ProductPriceType.md │ │ ├── ProductSortProperty.md │ │ ├── ProductUpdate.md │ │ ├── ProductUpdateMetadata.md │ │ ├── ProductUpdatePrices.md │ │ ├── Properties.md │ │ ├── PropertyAggregation.md │ │ ├── RefreshTokenRequest.md │ │ ├── Refund.md │ │ ├── RefundCreate.md │ │ ├── RefundCreateMetadata.md │ │ ├── RefundMetadata.md │ │ ├── RefundReason.md │ │ ├── RefundSortProperty.md │ │ ├── RefundStatus.md │ │ ├── RenewedSubscriptions.md │ │ ├── RenewedSubscriptionsRevenue.md │ │ ├── Revenue.md │ │ ├── RevokeTokenRequest.md │ │ ├── RevokeTokenResponse.md │ │ ├── S3DownloadURL.md │ │ ├── S3FileCreateMultipart.md │ │ ├── S3FileCreatePart.md │ │ ├── S3FileUploadCompletedPart.md │ │ ├── S3FileUploadMultipart.md │ │ ├── S3FileUploadPart.md │ │ ├── Scope.md │ │ ├── Security.md │ │ ├── SubType.md │ │ ├── Subscription.md │ │ ├── SubscriptionCancel.md │ │ ├── SubscriptionCustomer.md │ │ ├── SubscriptionCustomerMetadata.md │ │ ├── SubscriptionDiscount.md │ │ ├── SubscriptionMeter.md │ │ ├── SubscriptionPrices.md │ │ ├── SubscriptionProrationBehavior.md │ │ ├── SubscriptionRecurringInterval.md │ │ ├── SubscriptionRevoke.md │ │ ├── SubscriptionSortProperty.md │ │ ├── SubscriptionStatus.md │ │ ├── SubscriptionUpdate.md │ │ ├── SubscriptionUpdateProduct.md │ │ ├── SucceededCheckouts.md │ │ ├── SwitchingFrom.md │ │ ├── SystemEvent.md │ │ ├── TaxIDFormat.md │ │ ├── TaxId.md │ │ ├── TimeInterval.md │ │ ├── Timeframe.md │ │ ├── TokenEndpointAuthMethod.md │ │ ├── TokenResponse.md │ │ ├── TokenType.md │ │ ├── TokenTypeHint.md │ │ ├── UnitAmount.md │ │ ├── UserEvent.md │ │ ├── UserEventMetadata.md │ │ ├── UserInfoOrganization.md │ │ ├── UserInfoUser.md │ │ ├── ValidatedLicenseKey.md │ │ ├── ValidationError.md │ │ ├── Value.md │ │ ├── WebhookBenefitCreatedPayload.md │ │ ├── WebhookBenefitGrantCreatedPayload.md │ │ ├── WebhookBenefitGrantCycledPayload.md │ │ ├── WebhookBenefitGrantRevokedPayload.md │ │ ├── WebhookBenefitGrantUpdatedPayload.md │ │ ├── WebhookBenefitUpdatedPayload.md │ │ ├── WebhookCheckoutCreatedPayload.md │ │ ├── WebhookCheckoutUpdatedPayload.md │ │ ├── WebhookCustomerCreatedPayload.md │ │ ├── WebhookCustomerDeletedPayload.md │ │ ├── WebhookCustomerStateChangedPayload.md │ │ ├── WebhookCustomerUpdatedPayload.md │ │ ├── WebhookOrderCreatedPayload.md │ │ ├── WebhookOrderPaidPayload.md │ │ ├── WebhookOrderRefundedPayload.md │ │ ├── WebhookOrderUpdatedPayload.md │ │ ├── WebhookOrganizationUpdatedPayload.md │ │ ├── WebhookProductCreatedPayload.md │ │ ├── WebhookProductUpdatedPayload.md │ │ ├── WebhookRefundCreatedPayload.md │ │ ├── WebhookRefundUpdatedPayload.md │ │ ├── WebhookSubscriptionActivePayload.md │ │ ├── WebhookSubscriptionCanceledPayload.md │ │ ├── WebhookSubscriptionCreatedPayload.md │ │ ├── WebhookSubscriptionRevokedPayload.md │ │ ├── WebhookSubscriptionUncanceledPayload.md │ │ └── WebhookSubscriptionUpdatedPayload.md │ ├── Errors │ │ ├── AlreadyActiveSubscriptionError.md │ │ ├── AlreadyCanceledSubscription.md │ │ ├── CheckoutForbiddenError.md │ │ ├── CustomerPortalOrdersGenerateInvoiceResponse422CustomerPortalOrdersGenerateInvoice.md │ │ ├── ExpiredCheckoutError.md │ │ ├── HTTPValidationError.md │ │ ├── InvoiceAlreadyExists.md │ │ ├── MissingInvoiceBillingDetails.md │ │ ├── NotOpenCheckout.md │ │ ├── NotPaidOrder.md │ │ ├── NotPermitted.md │ │ ├── OrdersGenerateInvoiceResponse422OrdersGenerateInvoice.md │ │ ├── PaymentError.md │ │ ├── RefundAmountTooHigh.md │ │ ├── RefundedAlready.md │ │ ├── ResourceNotFound.md │ │ └── Unauthorized.md │ ├── Operations │ │ ├── BenefitIDFilter.md │ │ ├── BenefitTypeFilter.md │ │ ├── BenefitsCreateResponse.md │ │ ├── BenefitsDeleteRequest.md │ │ ├── BenefitsDeleteResponse.md │ │ ├── BenefitsGetRequest.md │ │ ├── BenefitsGetResponse.md │ │ ├── BenefitsGrantsRequest.md │ │ ├── BenefitsGrantsResponse.md │ │ ├── BenefitsListRequest.md │ │ ├── BenefitsListResponse.md │ │ ├── BenefitsUpdateBenefitUpdate.md │ │ ├── BenefitsUpdateRequest.md │ │ ├── BenefitsUpdateResponse.md │ │ ├── CheckoutIDFilter.md │ │ ├── CheckoutLinksCreateCheckoutLinkCreate.md │ │ ├── CheckoutLinksCreateResponse.md │ │ ├── CheckoutLinksDeleteRequest.md │ │ ├── CheckoutLinksDeleteResponse.md │ │ ├── CheckoutLinksGetRequest.md │ │ ├── CheckoutLinksGetResponse.md │ │ ├── CheckoutLinksListQueryParamOrganizationIDFilter.md │ │ ├── CheckoutLinksListQueryParamProductIDFilter.md │ │ ├── CheckoutLinksListRequest.md │ │ ├── CheckoutLinksListResponse.md │ │ ├── CheckoutLinksUpdateRequest.md │ │ ├── CheckoutLinksUpdateResponse.md │ │ ├── CheckoutsClientConfirmRequest.md │ │ ├── CheckoutsClientConfirmResponse.md │ │ ├── CheckoutsClientGetRequest.md │ │ ├── CheckoutsClientGetResponse.md │ │ ├── CheckoutsClientUpdateRequest.md │ │ ├── CheckoutsClientUpdateResponse.md │ │ ├── CheckoutsCreateResponse.md │ │ ├── CheckoutsGetRequest.md │ │ ├── CheckoutsGetResponse.md │ │ ├── CheckoutsListQueryParamCustomerIDFilter.md │ │ ├── CheckoutsListQueryParamOrganizationIDFilter.md │ │ ├── CheckoutsListQueryParamProductIDFilter.md │ │ ├── CheckoutsListRequest.md │ │ ├── CheckoutsListResponse.md │ │ ├── CheckoutsUpdateRequest.md │ │ ├── CheckoutsUpdateResponse.md │ │ ├── CustomFieldTypeFilter.md │ │ ├── CustomFieldsCreateResponse.md │ │ ├── CustomFieldsDeleteRequest.md │ │ ├── CustomFieldsDeleteResponse.md │ │ ├── CustomFieldsGetRequest.md │ │ ├── CustomFieldsGetResponse.md │ │ ├── CustomFieldsListQueryParamOrganizationIDFilter.md │ │ ├── CustomFieldsListRequest.md │ │ ├── CustomFieldsListResponse.md │ │ ├── CustomFieldsUpdateRequest.md │ │ ├── CustomFieldsUpdateResponse.md │ │ ├── CustomerEmailFilter.md │ │ ├── CustomerIDFilter.md │ │ ├── CustomerMetersGetRequest.md │ │ ├── CustomerMetersGetResponse.md │ │ ├── CustomerMetersListQueryParamCustomerIDFilter.md │ │ ├── CustomerMetersListQueryParamExternalCustomerIDFilter.md │ │ ├── CustomerMetersListQueryParamOrganizationIDFilter.md │ │ ├── CustomerMetersListRequest.md │ │ ├── CustomerMetersListResponse.md │ │ ├── CustomerPortalBenefitGrantsGetRequest.md │ │ ├── CustomerPortalBenefitGrantsGetResponse.md │ │ ├── CustomerPortalBenefitGrantsGetSecurity.md │ │ ├── CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter.md │ │ ├── CustomerPortalBenefitGrantsListQueryParamOrganizationIDFilter.md │ │ ├── CustomerPortalBenefitGrantsListRequest.md │ │ ├── CustomerPortalBenefitGrantsListResponse.md │ │ ├── CustomerPortalBenefitGrantsListSecurity.md │ │ ├── CustomerPortalBenefitGrantsUpdateRequest.md │ │ ├── CustomerPortalBenefitGrantsUpdateResponse.md │ │ ├── CustomerPortalBenefitGrantsUpdateSecurity.md │ │ ├── CustomerPortalCustomerMetersGetRequest.md │ │ ├── CustomerPortalCustomerMetersGetResponse.md │ │ ├── CustomerPortalCustomerMetersGetSecurity.md │ │ ├── CustomerPortalCustomerMetersListRequest.md │ │ ├── CustomerPortalCustomerMetersListResponse.md │ │ ├── CustomerPortalCustomerMetersListSecurity.md │ │ ├── CustomerPortalCustomersAddPaymentMethodResponse.md │ │ ├── CustomerPortalCustomersAddPaymentMethodResponseCustomerPortalCustomersAddPaymentMethod.md │ │ ├── CustomerPortalCustomersAddPaymentMethodSecurity.md │ │ ├── CustomerPortalCustomersDeletePaymentMethodRequest.md │ │ ├── CustomerPortalCustomersDeletePaymentMethodResponse.md │ │ ├── CustomerPortalCustomersDeletePaymentMethodSecurity.md │ │ ├── CustomerPortalCustomersGetPaymentMethodsRequest.md │ │ ├── CustomerPortalCustomersGetPaymentMethodsResponse.md │ │ ├── CustomerPortalCustomersGetPaymentMethodsSecurity.md │ │ ├── CustomerPortalCustomersGetResponse.md │ │ ├── CustomerPortalCustomersGetSecurity.md │ │ ├── CustomerPortalCustomersUpdateResponse.md │ │ ├── CustomerPortalCustomersUpdateSecurity.md │ │ ├── CustomerPortalDownloadablesCustomerPortalDownloadablesGetRequest.md │ │ ├── CustomerPortalDownloadablesCustomerPortalDownloadablesGetResponse.md │ │ ├── CustomerPortalDownloadablesListQueryParamBenefitIDFilter.md │ │ ├── CustomerPortalDownloadablesListQueryParamOrganizationIDFilter.md │ │ ├── CustomerPortalDownloadablesListRequest.md │ │ ├── CustomerPortalDownloadablesListResponse.md │ │ ├── CustomerPortalDownloadablesListSecurity.md │ │ ├── CustomerPortalLicenseKeysActivateResponse.md │ │ ├── CustomerPortalLicenseKeysDeactivateResponse.md │ │ ├── CustomerPortalLicenseKeysGetRequest.md │ │ ├── CustomerPortalLicenseKeysGetResponse.md │ │ ├── CustomerPortalLicenseKeysGetSecurity.md │ │ ├── CustomerPortalLicenseKeysListQueryParamOrganizationIDFilter.md │ │ ├── CustomerPortalLicenseKeysListRequest.md │ │ ├── CustomerPortalLicenseKeysListResponse.md │ │ ├── CustomerPortalLicenseKeysListSecurity.md │ │ ├── CustomerPortalLicenseKeysValidateResponse.md │ │ ├── CustomerPortalOrdersGenerateInvoiceRequest.md │ │ ├── CustomerPortalOrdersGenerateInvoiceResponse.md │ │ ├── CustomerPortalOrdersGenerateInvoiceSecurity.md │ │ ├── CustomerPortalOrdersGetRequest.md │ │ ├── CustomerPortalOrdersGetResponse.md │ │ ├── CustomerPortalOrdersGetSecurity.md │ │ ├── CustomerPortalOrdersInvoiceRequest.md │ │ ├── CustomerPortalOrdersInvoiceResponse.md │ │ ├── CustomerPortalOrdersInvoiceSecurity.md │ │ ├── CustomerPortalOrdersListQueryParamOrganizationIDFilter.md │ │ ├── CustomerPortalOrdersListQueryParamProductBillingTypeFilter.md │ │ ├── CustomerPortalOrdersListQueryParamProductIDFilter.md │ │ ├── CustomerPortalOrdersListQueryParamSubscriptionIDFilter.md │ │ ├── CustomerPortalOrdersListRequest.md │ │ ├── CustomerPortalOrdersListResponse.md │ │ ├── CustomerPortalOrdersListSecurity.md │ │ ├── CustomerPortalOrdersUpdateRequest.md │ │ ├── CustomerPortalOrdersUpdateResponse.md │ │ ├── CustomerPortalOrdersUpdateSecurity.md │ │ ├── CustomerPortalOrganizationsGetRequest.md │ │ ├── CustomerPortalOrganizationsGetResponse.md │ │ ├── CustomerPortalSubscriptionsCancelRequest.md │ │ ├── CustomerPortalSubscriptionsCancelResponse.md │ │ ├── CustomerPortalSubscriptionsCancelSecurity.md │ │ ├── CustomerPortalSubscriptionsGetRequest.md │ │ ├── CustomerPortalSubscriptionsGetResponse.md │ │ ├── CustomerPortalSubscriptionsGetSecurity.md │ │ ├── CustomerPortalSubscriptionsListQueryParamOrganizationIDFilter.md │ │ ├── CustomerPortalSubscriptionsListQueryParamProductIDFilter.md │ │ ├── CustomerPortalSubscriptionsListRequest.md │ │ ├── CustomerPortalSubscriptionsListResponse.md │ │ ├── CustomerPortalSubscriptionsListSecurity.md │ │ ├── CustomerPortalSubscriptionsUpdateRequest.md │ │ ├── CustomerPortalSubscriptionsUpdateResponse.md │ │ ├── CustomerPortalSubscriptionsUpdateSecurity.md │ │ ├── CustomerSessionsCreateCustomerSessionCreate.md │ │ ├── CustomerSessionsCreateResponse.md │ │ ├── CustomersCreateResponse.md │ │ ├── CustomersDeleteExternalRequest.md │ │ ├── CustomersDeleteExternalResponse.md │ │ ├── CustomersDeleteRequest.md │ │ ├── CustomersDeleteResponse.md │ │ ├── CustomersGetExternalRequest.md │ │ ├── CustomersGetExternalResponse.md │ │ ├── CustomersGetRequest.md │ │ ├── CustomersGetResponse.md │ │ ├── CustomersGetStateExternalRequest.md │ │ ├── CustomersGetStateExternalResponse.md │ │ ├── CustomersGetStateRequest.md │ │ ├── CustomersGetStateResponse.md │ │ ├── CustomersListQueryParamOrganizationIDFilter.md │ │ ├── CustomersListRequest.md │ │ ├── CustomersListResponse.md │ │ ├── CustomersUpdateExternalRequest.md │ │ ├── CustomersUpdateExternalResponse.md │ │ ├── CustomersUpdateRequest.md │ │ ├── CustomersUpdateResponse.md │ │ ├── DiscountIDFilter.md │ │ ├── DiscountsCreateResponse.md │ │ ├── DiscountsDeleteRequest.md │ │ ├── DiscountsDeleteResponse.md │ │ ├── DiscountsGetRequest.md │ │ ├── DiscountsGetResponse.md │ │ ├── DiscountsListQueryParamOrganizationIDFilter.md │ │ ├── DiscountsListRequest.md │ │ ├── DiscountsListResponse.md │ │ ├── DiscountsUpdateRequest.md │ │ ├── DiscountsUpdateResponse.md │ │ ├── EventsGetRequest.md │ │ ├── EventsGetResponse.md │ │ ├── EventsIngestResponse.md │ │ ├── EventsListNamesQueryParamCustomerIDFilter.md │ │ ├── EventsListNamesQueryParamOrganizationIDFilter.md │ │ ├── EventsListNamesRequest.md │ │ ├── EventsListNamesResponse.md │ │ ├── EventsListQueryParamCustomerIDFilter.md │ │ ├── EventsListQueryParamOrganizationIDFilter.md │ │ ├── EventsListRequest.md │ │ ├── EventsListResponse.md │ │ ├── ExternalCustomerIDFilter.md │ │ ├── FileIDFilter.md │ │ ├── FilesCreateResponse.md │ │ ├── FilesDeleteRequest.md │ │ ├── FilesDeleteResponse.md │ │ ├── FilesListQueryParamOrganizationIDFilter.md │ │ ├── FilesListRequest.md │ │ ├── FilesListResponse.md │ │ ├── FilesUpdateRequest.md │ │ ├── FilesUpdateResponse.md │ │ ├── FilesUpdateResponseFilesUpdate.md │ │ ├── FilesUploadedRequest.md │ │ ├── FilesUploadedResponse.md │ │ ├── FilesUploadedResponseFilesUploaded.md │ │ ├── LicenseKeysGetActivationRequest.md │ │ ├── LicenseKeysGetActivationResponse.md │ │ ├── LicenseKeysGetRequest.md │ │ ├── LicenseKeysGetResponse.md │ │ ├── LicenseKeysListQueryParamOrganizationIDFilter.md │ │ ├── LicenseKeysListRequest.md │ │ ├── LicenseKeysListResponse.md │ │ ├── LicenseKeysUpdateRequest.md │ │ ├── LicenseKeysUpdateResponse.md │ │ ├── MeterIDFilter.md │ │ ├── MetersCreateResponse.md │ │ ├── MetersGetRequest.md │ │ ├── MetersGetResponse.md │ │ ├── MetersListQueryParamOrganizationIDFilter.md │ │ ├── MetersListRequest.md │ │ ├── MetersListResponse.md │ │ ├── MetersQuantitiesQueryParamCustomerIDFilter.md │ │ ├── MetersQuantitiesQueryParamExternalCustomerIDFilter.md │ │ ├── MetersQuantitiesRequest.md │ │ ├── MetersQuantitiesResponse.md │ │ ├── MetersUpdateRequest.md │ │ ├── MetersUpdateResponse.md │ │ ├── MethodFilter.md │ │ ├── MetricsGetQueryParamCustomerIDFilter.md │ │ ├── MetricsGetQueryParamOrganizationIDFilter.md │ │ ├── MetricsGetQueryParamProductIDFilter.md │ │ ├── MetricsGetRequest.md │ │ ├── MetricsGetResponse.md │ │ ├── MetricsLimitsResponse.md │ │ ├── NameFilter.md │ │ ├── Oauth2AuthorizeResponse.md │ │ ├── Oauth2AuthorizeResponseOauth2Authorize.md │ │ ├── Oauth2ClientsListRequest.md │ │ ├── Oauth2ClientsListResponse.md │ │ ├── Oauth2ClientsOauth2CreateClientResponse.md │ │ ├── Oauth2ClientsOauth2DeleteClientRequest.md │ │ ├── Oauth2ClientsOauth2DeleteClientResponse.md │ │ ├── Oauth2ClientsOauth2GetClientRequest.md │ │ ├── Oauth2ClientsOauth2GetClientResponse.md │ │ ├── Oauth2ClientsOauth2UpdateClientRequest.md │ │ ├── Oauth2ClientsOauth2UpdateClientResponse.md │ │ ├── Oauth2IntrospectTokenResponse.md │ │ ├── Oauth2RequestTokenRequestBody.md │ │ ├── Oauth2RequestTokenResponse.md │ │ ├── Oauth2RevokeTokenResponse.md │ │ ├── Oauth2UserinfoResponse.md │ │ ├── Oauth2UserinfoResponseOauth2Userinfo.md │ │ ├── OrderIDFilter.md │ │ ├── OrdersGenerateInvoiceRequest.md │ │ ├── OrdersGenerateInvoiceResponse.md │ │ ├── OrdersGetRequest.md │ │ ├── OrdersGetResponse.md │ │ ├── OrdersInvoiceRequest.md │ │ ├── OrdersInvoiceResponse.md │ │ ├── OrdersListQueryParamCustomerIDFilter.md │ │ ├── OrdersListQueryParamOrganizationIDFilter.md │ │ ├── OrdersListQueryParamProductIDFilter.md │ │ ├── OrdersListRequest.md │ │ ├── OrdersListResponse.md │ │ ├── OrdersUpdateRequest.md │ │ ├── OrdersUpdateResponse.md │ │ ├── OrganizationIDFilter.md │ │ ├── OrganizationId.md │ │ ├── OrganizationsCreateResponse.md │ │ ├── OrganizationsGetRequest.md │ │ ├── OrganizationsGetResponse.md │ │ ├── OrganizationsListRequest.md │ │ ├── OrganizationsListResponse.md │ │ ├── OrganizationsUpdateRequest.md │ │ ├── OrganizationsUpdateResponse.md │ │ ├── PaymentsGetRequest.md │ │ ├── PaymentsGetResponse.md │ │ ├── PaymentsListQueryParamCheckoutIDFilter.md │ │ ├── PaymentsListQueryParamOrderIDFilter.md │ │ ├── PaymentsListQueryParamOrganizationIDFilter.md │ │ ├── PaymentsListRequest.md │ │ ├── PaymentsListResponse.md │ │ ├── ProductBillingTypeFilter.md │ │ ├── ProductIDFilter.md │ │ ├── ProductsCreateResponse.md │ │ ├── ProductsGetRequest.md │ │ ├── ProductsGetResponse.md │ │ ├── ProductsListQueryParamOrganizationIDFilter.md │ │ ├── ProductsListRequest.md │ │ ├── ProductsListResponse.md │ │ ├── ProductsUpdateBenefitsRequest.md │ │ ├── ProductsUpdateBenefitsResponse.md │ │ ├── ProductsUpdateRequest.md │ │ ├── ProductsUpdateResponse.md │ │ ├── QueryParamBenefitIDFilter.md │ │ ├── QueryParamBenefitTypeFilter.md │ │ ├── QueryParamCheckoutIDFilter.md │ │ ├── QueryParamCustomerIDFilter.md │ │ ├── QueryParamDiscountIDFilter.md │ │ ├── QueryParamExternalCustomerIDFilter.md │ │ ├── QueryParamMeterIDFilter.md │ │ ├── QueryParamOrderIDFilter.md │ │ ├── QueryParamOrganizationIDFilter.md │ │ ├── QueryParamProductBillingTypeFilter.md │ │ ├── QueryParamProductIDFilter.md │ │ ├── QueryParamSourceFilter.md │ │ ├── QueryParamStatusFilter.md │ │ ├── QueryParamSubscriptionIDFilter.md │ │ ├── RefundIDFilter.md │ │ ├── RefundsCreateResponse.md │ │ ├── RefundsListQueryParamCustomerIDFilter.md │ │ ├── RefundsListQueryParamOrganizationIDFilter.md │ │ ├── RefundsListRequest.md │ │ ├── RefundsListResponse.md │ │ ├── SourceFilter.md │ │ ├── StatusFilter.md │ │ ├── SubscriptionIDFilter.md │ │ ├── SubscriptionsExportRequest.md │ │ ├── SubscriptionsExportResponse.md │ │ ├── SubscriptionsGetRequest.md │ │ ├── SubscriptionsGetResponse.md │ │ ├── SubscriptionsListRequest.md │ │ ├── SubscriptionsListResponse.md │ │ ├── SubscriptionsRevokeRequest.md │ │ ├── SubscriptionsRevokeResponse.md │ │ ├── SubscriptionsUpdateRequest.md │ │ └── SubscriptionsUpdateResponse.md │ └── Webhooks │ │ ├── EndpointbenefitCreatedPostResponse.md │ │ ├── EndpointbenefitGrantCreatedPostResponse.md │ │ ├── EndpointbenefitGrantCycledPostResponse.md │ │ ├── EndpointbenefitGrantRevokedPostResponse.md │ │ ├── EndpointbenefitGrantUpdatedPostResponse.md │ │ ├── EndpointbenefitUpdatedPostResponse.md │ │ ├── EndpointcheckoutCreatedPostResponse.md │ │ ├── EndpointcheckoutUpdatedPostResponse.md │ │ ├── EndpointcustomerCreatedPostResponse.md │ │ ├── EndpointcustomerDeletedPostResponse.md │ │ ├── EndpointcustomerStateChangedPostResponse.md │ │ ├── EndpointcustomerUpdatedPostResponse.md │ │ ├── EndpointorderCreatedPostResponse.md │ │ ├── EndpointorderPaidPostResponse.md │ │ ├── EndpointorderRefundedPostResponse.md │ │ ├── EndpointorderUpdatedPostResponse.md │ │ ├── EndpointorganizationUpdatedPostResponse.md │ │ ├── EndpointproductCreatedPostResponse.md │ │ ├── EndpointproductUpdatedPostResponse.md │ │ ├── EndpointrefundCreatedPostResponse.md │ │ ├── EndpointrefundUpdatedPostResponse.md │ │ ├── EndpointsubscriptionActivePostResponse.md │ │ ├── EndpointsubscriptionCanceledPostResponse.md │ │ ├── EndpointsubscriptionCreatedPostResponse.md │ │ ├── EndpointsubscriptionRevokedPostResponse.md │ │ ├── EndpointsubscriptionUncanceledPostResponse.md │ │ └── EndpointsubscriptionUpdatedPostResponse.md └── sdks │ ├── benefitgrants │ └── README.md │ ├── benefits │ └── README.md │ ├── checkoutlinks │ └── README.md │ ├── checkouts │ └── README.md │ ├── clients │ └── README.md │ ├── customermeters │ └── README.md │ ├── customerportal │ └── README.md │ ├── customers │ └── README.md │ ├── customersessions │ └── README.md │ ├── customfields │ └── README.md │ ├── discounts │ └── README.md │ ├── downloadables │ └── README.md │ ├── events │ └── README.md │ ├── files │ └── README.md │ ├── licensekeys │ └── README.md │ ├── meters │ └── README.md │ ├── metrics │ └── README.md │ ├── oauth2 │ └── README.md │ ├── orders │ └── README.md │ ├── organizations │ └── README.md │ ├── payments │ └── README.md │ ├── polar │ └── README.md │ ├── polarcustomermeters │ └── README.md │ ├── polarcustomers │ └── README.md │ ├── polarlicensekeys │ └── README.md │ ├── polarorders │ └── README.md │ ├── polarorganizations │ └── README.md │ ├── polarsubscriptions │ └── README.md │ ├── products │ └── README.md │ ├── refunds │ └── README.md │ └── subscriptions │ └── README.md ├── phpstan.neon ├── phpunit.xml ├── pint.json ├── rector.php └── src ├── BenefitGrants.php ├── Benefits.php ├── CheckoutLinks.php ├── Checkouts.php ├── Clients.php ├── CustomFields.php ├── CustomerMeters.php ├── CustomerPortal.php ├── CustomerSessions.php ├── Customers.php ├── Discounts.php ├── Downloadables.php ├── Events.php ├── Files.php ├── Hooks ├── AfterErrorContext.php ├── AfterErrorHook.php ├── AfterSuccessContext.php ├── AfterSuccessHook.php ├── BeforeRequestContext.php ├── BeforeRequestHook.php ├── Credentials.php ├── ErrorResponseContext.php ├── FailEarlyException.php ├── HookContext.php ├── HookRegistration.php ├── Hooks.php ├── SDKHooks.php ├── SDKInitHook.php ├── SDKRequestContext.php ├── Session.php └── TokenResponse.php ├── LicenseKeys.php ├── Meters.php ├── Metrics.php ├── Models ├── Components │ ├── Address.php │ ├── AttachedCustomField.php │ ├── AttachedCustomFieldCreate.php │ ├── AuthorizationCodeTokenRequest.php │ ├── AuthorizeOrganization.php │ ├── AuthorizeResponseOrganization.php │ ├── AuthorizeResponseUser.php │ ├── AuthorizeUser.php │ ├── BenefitCustom.php │ ├── BenefitCustomCreate.php │ ├── BenefitCustomCreateProperties.php │ ├── BenefitCustomProperties.php │ ├── BenefitCustomSubscriber.php │ ├── BenefitCustomSubscriberProperties.php │ ├── BenefitCustomUpdate.php │ ├── BenefitCycledEvent.php │ ├── BenefitDiscord.php │ ├── BenefitDiscordCreate.php │ ├── BenefitDiscordCreateProperties.php │ ├── BenefitDiscordProperties.php │ ├── BenefitDiscordSubscriber.php │ ├── BenefitDiscordSubscriberProperties.php │ ├── BenefitDiscordUpdate.php │ ├── BenefitDownloadables.php │ ├── BenefitDownloadablesCreate.php │ ├── BenefitDownloadablesCreateProperties.php │ ├── BenefitDownloadablesProperties.php │ ├── BenefitDownloadablesSubscriber.php │ ├── BenefitDownloadablesSubscriberProperties.php │ ├── BenefitDownloadablesUpdate.php │ ├── BenefitGitHubRepository.php │ ├── BenefitGitHubRepositoryCreate.php │ ├── BenefitGitHubRepositoryCreateProperties.php │ ├── BenefitGitHubRepositoryCreatePropertiesPermission.php │ ├── BenefitGitHubRepositoryProperties.php │ ├── BenefitGitHubRepositorySubscriber.php │ ├── BenefitGitHubRepositorySubscriberProperties.php │ ├── BenefitGitHubRepositoryUpdate.php │ ├── BenefitGrant.php │ ├── BenefitGrantCustomProperties.php │ ├── BenefitGrantDiscordProperties.php │ ├── BenefitGrantDownloadablesProperties.php │ ├── BenefitGrantError.php │ ├── BenefitGrantGitHubRepositoryProperties.php │ ├── BenefitGrantGitHubRepositoryPropertiesPermission.php │ ├── BenefitGrantLicenseKeysProperties.php │ ├── BenefitGrantMetadata.php │ ├── BenefitGrantMeterCreditProperties.php │ ├── BenefitGrantWebhook.php │ ├── BenefitGrantedEvent.php │ ├── BenefitLicenseKeyActivationCreateProperties.php │ ├── BenefitLicenseKeyActivationProperties.php │ ├── BenefitLicenseKeyExpirationProperties.php │ ├── BenefitLicenseKeys.php │ ├── BenefitLicenseKeysCreate.php │ ├── BenefitLicenseKeysCreateProperties.php │ ├── BenefitLicenseKeysProperties.php │ ├── BenefitLicenseKeysSubscriber.php │ ├── BenefitLicenseKeysSubscriberProperties.php │ ├── BenefitLicenseKeysUpdate.php │ ├── BenefitMeterCredit.php │ ├── BenefitMeterCreditCreate.php │ ├── BenefitMeterCreditCreateProperties.php │ ├── BenefitMeterCreditProperties.php │ ├── BenefitMeterCreditSubscriber.php │ ├── BenefitMeterCreditSubscriberProperties.php │ ├── BenefitMeterCreditUpdate.php │ ├── BenefitPublic.php │ ├── BenefitRevokedEvent.php │ ├── BenefitSortProperty.php │ ├── BenefitType.php │ ├── BenefitUpdatedEvent.php │ ├── CardPayment.php │ ├── CardPaymentMetadata.php │ ├── Checkout.php │ ├── CheckoutConfirmStripe.php │ ├── CheckoutCreate.php │ ├── CheckoutCustomerBillingAddressFields.php │ ├── CheckoutDiscountFixedOnceForeverDuration.php │ ├── CheckoutDiscountFixedRepeatDuration.php │ ├── CheckoutDiscountPercentageOnceForeverDuration.php │ ├── CheckoutDiscountPercentageRepeatDuration.php │ ├── CheckoutLink.php │ ├── CheckoutLinkCreateProduct.php │ ├── CheckoutLinkCreateProductPrice.php │ ├── CheckoutLinkCreateProducts.php │ ├── CheckoutLinkProduct.php │ ├── CheckoutLinkSortProperty.php │ ├── CheckoutLinkUpdate.php │ ├── CheckoutProduct.php │ ├── CheckoutPublic.php │ ├── CheckoutPublicConfirmed.php │ ├── CheckoutSortProperty.php │ ├── CheckoutStatus.php │ ├── CheckoutUpdate.php │ ├── CheckoutUpdatePublic.php │ ├── CountAggregation.php │ ├── CustomFieldCheckbox.php │ ├── CustomFieldCheckboxProperties.php │ ├── CustomFieldCreateCheckbox.php │ ├── CustomFieldCreateDate.php │ ├── CustomFieldCreateNumber.php │ ├── CustomFieldCreateSelect.php │ ├── CustomFieldCreateText.php │ ├── CustomFieldDate.php │ ├── CustomFieldDateProperties.php │ ├── CustomFieldNumber.php │ ├── CustomFieldNumberProperties.php │ ├── CustomFieldSelect.php │ ├── CustomFieldSelectOption.php │ ├── CustomFieldSelectProperties.php │ ├── CustomFieldSortProperty.php │ ├── CustomFieldText.php │ ├── CustomFieldTextProperties.php │ ├── CustomFieldType.php │ ├── CustomFieldUpdateCheckbox.php │ ├── CustomFieldUpdateDate.php │ ├── CustomFieldUpdateNumber.php │ ├── CustomFieldUpdateSelect.php │ ├── CustomFieldUpdateText.php │ ├── Customer.php │ ├── CustomerBenefitGrantCustom.php │ ├── CustomerBenefitGrantCustomUpdate.php │ ├── CustomerBenefitGrantDiscord.php │ ├── CustomerBenefitGrantDiscordPropertiesUpdate.php │ ├── CustomerBenefitGrantDiscordUpdate.php │ ├── CustomerBenefitGrantDownloadables.php │ ├── CustomerBenefitGrantDownloadablesUpdate.php │ ├── CustomerBenefitGrantGitHubRepository.php │ ├── CustomerBenefitGrantGitHubRepositoryPropertiesUpdate.php │ ├── CustomerBenefitGrantGitHubRepositoryUpdate.php │ ├── CustomerBenefitGrantLicenseKeys.php │ ├── CustomerBenefitGrantLicenseKeysUpdate.php │ ├── CustomerBenefitGrantMeterCredit.php │ ├── CustomerBenefitGrantMeterCreditUpdate.php │ ├── CustomerBenefitGrantSortProperty.php │ ├── CustomerCancellationReason.php │ ├── CustomerCreate.php │ ├── CustomerCustomerMeter.php │ ├── CustomerCustomerMeterMeter.php │ ├── CustomerCustomerMeterSortProperty.php │ ├── CustomerMeter.php │ ├── CustomerMeterSortProperty.php │ ├── CustomerOrder.php │ ├── CustomerOrderInvoice.php │ ├── CustomerOrderProduct.php │ ├── CustomerOrderSortProperty.php │ ├── CustomerOrderSubscription.php │ ├── CustomerOrderUpdate.php │ ├── CustomerOrganization.php │ ├── CustomerPaymentMethodCreate.php │ ├── CustomerPortalCustomer.php │ ├── CustomerPortalCustomerUpdate.php │ ├── CustomerPortalOAuthAccount.php │ ├── CustomerProduct.php │ ├── CustomerSession.php │ ├── CustomerSessionCustomerExternalIDCreate.php │ ├── CustomerSessionCustomerIDCreate.php │ ├── CustomerSortProperty.php │ ├── CustomerState.php │ ├── CustomerStateBenefitGrant.php │ ├── CustomerStateMeter.php │ ├── CustomerStateSubscription.php │ ├── CustomerStateSubscriptionMeter.php │ ├── CustomerSubscription.php │ ├── CustomerSubscriptionCancel.php │ ├── CustomerSubscriptionMeter.php │ ├── CustomerSubscriptionMeterMeter.php │ ├── CustomerSubscriptionProduct.php │ ├── CustomerSubscriptionSortProperty.php │ ├── CustomerSubscriptionUpdateProduct.php │ ├── CustomerUpdate.php │ ├── CustomerUpdateExternalID.php │ ├── DiscountDuration.php │ ├── DiscountFixedOnceForeverDuration.php │ ├── DiscountFixedOnceForeverDurationBase.php │ ├── DiscountFixedOnceForeverDurationCreate.php │ ├── DiscountFixedRepeatDuration.php │ ├── DiscountFixedRepeatDurationBase.php │ ├── DiscountFixedRepeatDurationCreate.php │ ├── DiscountPercentageOnceForeverDuration.php │ ├── DiscountPercentageOnceForeverDurationBase.php │ ├── DiscountPercentageOnceForeverDurationCreate.php │ ├── DiscountPercentageRepeatDuration.php │ ├── DiscountPercentageRepeatDurationBase.php │ ├── DiscountPercentageRepeatDurationCreate.php │ ├── DiscountProduct.php │ ├── DiscountSortProperty.php │ ├── DiscountType.php │ ├── DiscountUpdate.php │ ├── DownloadableFileCreate.php │ ├── DownloadableFileRead.php │ ├── DownloadableRead.php │ ├── EventCreateCustomer.php │ ├── EventCreateExternalCustomer.php │ ├── EventName.php │ ├── EventNamesSortProperty.php │ ├── EventSortProperty.php │ ├── EventSource.php │ ├── EventsIngest.php │ ├── EventsIngestResponse.php │ ├── ExistingProductPrice.php │ ├── FileDownload.php │ ├── FilePatch.php │ ├── FileServiceTypes.php │ ├── FileUpload.php │ ├── FileUploadCompleted.php │ ├── Filter.php │ ├── FilterClause.php │ ├── FilterConjunction.php │ ├── FilterOperator.php │ ├── Func.php │ ├── GenericPayment.php │ ├── GrantTypes.php │ ├── IntrospectTokenRequest.php │ ├── IntrospectTokenRequestTokenTypeHint.php │ ├── IntrospectTokenResponse.php │ ├── LegacyRecurringProductPriceCustom.php │ ├── LegacyRecurringProductPriceFixed.php │ ├── LegacyRecurringProductPriceFree.php │ ├── LicenseKeyActivate.php │ ├── LicenseKeyActivationBase.php │ ├── LicenseKeyActivationRead.php │ ├── LicenseKeyCustomer.php │ ├── LicenseKeyDeactivate.php │ ├── LicenseKeyRead.php │ ├── LicenseKeyStatus.php │ ├── LicenseKeyUpdate.php │ ├── LicenseKeyValidate.php │ ├── LicenseKeyWithActivations.php │ ├── ListResource.php │ ├── ListResourceBenefit.php │ ├── ListResourceBenefitGrant.php │ ├── ListResourceCheckout.php │ ├── ListResourceCheckoutLink.php │ ├── ListResourceCustomField.php │ ├── ListResourceCustomer.php │ ├── ListResourceCustomerBenefitGrant.php │ ├── ListResourceCustomerCustomerMeter.php │ ├── ListResourceCustomerMeter.php │ ├── ListResourceCustomerOrder.php │ ├── ListResourceCustomerSubscription.php │ ├── ListResourceDiscount.php │ ├── ListResourceDownloadableRead.php │ ├── ListResourceEvent.php │ ├── ListResourceEventName.php │ ├── ListResourceFileRead.php │ ├── ListResourceLicenseKeyRead.php │ ├── ListResourceMeter.php │ ├── ListResourceOAuth2Client.php │ ├── ListResourceOrder.php │ ├── ListResourceOrganization.php │ ├── ListResourceProduct.php │ ├── ListResourceRefund.php │ ├── ListResourceSubscription.php │ ├── ListResourceUnionPaymentMethodCardPaymentMethodGeneric.php │ ├── Meter.php │ ├── MeterCreate.php │ ├── MeterCreditEvent.php │ ├── MeterCreditedMetadata.php │ ├── MeterQuantities.php │ ├── MeterQuantity.php │ ├── MeterResetEvent.php │ ├── MeterResetMetadata.php │ ├── MeterSortProperty.php │ ├── MeterUpdate.php │ ├── Metric.php │ ├── MetricPeriod.php │ ├── MetricType.php │ ├── Metrics.php │ ├── MetricsIntervalLimit.php │ ├── MetricsIntervalsLimits.php │ ├── MetricsLimits.php │ ├── MetricsResponse.php │ ├── MetricsTotals.php │ ├── OAuth2Client.php │ ├── OAuth2ClientConfiguration.php │ ├── OAuth2ClientConfigurationGrantTypes.php │ ├── OAuth2ClientConfigurationTokenEndpointAuthMethod.php │ ├── OAuth2ClientConfigurationUpdate.php │ ├── OAuth2ClientConfigurationUpdateGrantTypes.php │ ├── OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod.php │ ├── OAuth2ClientPublic.php │ ├── Order.php │ ├── OrderBillingReason.php │ ├── OrderCustomer.php │ ├── OrderInvoice.php │ ├── OrderItemSchema.php │ ├── OrderProduct.php │ ├── OrderSortProperty.php │ ├── OrderStatus.php │ ├── OrderSubscription.php │ ├── OrderUpdate.php │ ├── Organization.php │ ├── OrganizationAvatarFileCreate.php │ ├── OrganizationAvatarFileRead.php │ ├── OrganizationCreate.php │ ├── OrganizationDetails.php │ ├── OrganizationFeatureSettings.php │ ├── OrganizationSocialLink.php │ ├── OrganizationSocialPlatforms.php │ ├── OrganizationSortProperty.php │ ├── OrganizationSubscriptionSettings.php │ ├── OrganizationUpdate.php │ ├── Pagination.php │ ├── PaymentMethodCard.php │ ├── PaymentMethodCardData.php │ ├── PaymentMethodGeneric.php │ ├── PaymentProcessor.php │ ├── PaymentSortProperty.php │ ├── PaymentStatus.php │ ├── Permission.php │ ├── Product.php │ ├── ProductBenefitsUpdate.php │ ├── ProductBillingType.php │ ├── ProductCreate.php │ ├── ProductMediaFileCreate.php │ ├── ProductMediaFileRead.php │ ├── ProductPriceCustom.php │ ├── ProductPriceCustomCreate.php │ ├── ProductPriceFixed.php │ ├── ProductPriceFixedCreate.php │ ├── ProductPriceFree.php │ ├── ProductPriceFreeCreate.php │ ├── ProductPriceMeter.php │ ├── ProductPriceMeteredUnit.php │ ├── ProductPriceMeteredUnitCreate.php │ ├── ProductPriceType.php │ ├── ProductSortProperty.php │ ├── ProductUpdate.php │ ├── PropertyAggregation.php │ ├── RefreshTokenRequest.php │ ├── Refund.php │ ├── RefundCreate.php │ ├── RefundReason.php │ ├── RefundSortProperty.php │ ├── RefundStatus.php │ ├── RevokeTokenRequest.php │ ├── RevokeTokenResponse.php │ ├── S3DownloadURL.php │ ├── S3FileCreateMultipart.php │ ├── S3FileCreatePart.php │ ├── S3FileUploadCompletedPart.php │ ├── S3FileUploadMultipart.php │ ├── S3FileUploadPart.php │ ├── Scope.php │ ├── Security.php │ ├── SubType.php │ ├── Subscription.php │ ├── SubscriptionCancel.php │ ├── SubscriptionCustomer.php │ ├── SubscriptionMeter.php │ ├── SubscriptionProrationBehavior.php │ ├── SubscriptionRecurringInterval.php │ ├── SubscriptionRevoke.php │ ├── SubscriptionSortProperty.php │ ├── SubscriptionStatus.php │ ├── SubscriptionUpdateProduct.php │ ├── SwitchingFrom.php │ ├── TaxIDFormat.php │ ├── TimeInterval.php │ ├── Timeframe.php │ ├── TokenEndpointAuthMethod.php │ ├── TokenResponse.php │ ├── TokenType.php │ ├── TokenTypeHint.php │ ├── UserEvent.php │ ├── UserInfoOrganization.php │ ├── UserInfoUser.php │ ├── ValidatedLicenseKey.php │ ├── ValidationError.php │ ├── WebhookBenefitCreatedPayload.php │ ├── WebhookBenefitGrantCreatedPayload.php │ ├── WebhookBenefitGrantCycledPayload.php │ ├── WebhookBenefitGrantRevokedPayload.php │ ├── WebhookBenefitGrantUpdatedPayload.php │ ├── WebhookBenefitUpdatedPayload.php │ ├── WebhookCheckoutCreatedPayload.php │ ├── WebhookCheckoutUpdatedPayload.php │ ├── WebhookCustomerCreatedPayload.php │ ├── WebhookCustomerDeletedPayload.php │ ├── WebhookCustomerStateChangedPayload.php │ ├── WebhookCustomerUpdatedPayload.php │ ├── WebhookOrderCreatedPayload.php │ ├── WebhookOrderPaidPayload.php │ ├── WebhookOrderRefundedPayload.php │ ├── WebhookOrderUpdatedPayload.php │ ├── WebhookOrganizationUpdatedPayload.php │ ├── WebhookProductCreatedPayload.php │ ├── WebhookProductUpdatedPayload.php │ ├── WebhookRefundCreatedPayload.php │ ├── WebhookRefundUpdatedPayload.php │ ├── WebhookSubscriptionActivePayload.php │ ├── WebhookSubscriptionCanceledPayload.php │ ├── WebhookSubscriptionCreatedPayload.php │ ├── WebhookSubscriptionRevokedPayload.php │ ├── WebhookSubscriptionUncanceledPayload.php │ └── WebhookSubscriptionUpdatedPayload.php ├── Errors │ ├── APIException.php │ ├── AlreadyActiveSubscriptionError.php │ ├── AlreadyActiveSubscriptionErrorThrowable.php │ ├── AlreadyCanceledSubscription.php │ ├── AlreadyCanceledSubscriptionThrowable.php │ ├── ExpiredCheckoutError.php │ ├── ExpiredCheckoutErrorThrowable.php │ ├── HTTPValidationError.php │ ├── HTTPValidationErrorThrowable.php │ ├── InvoiceAlreadyExists.php │ ├── InvoiceAlreadyExistsThrowable.php │ ├── MissingInvoiceBillingDetails.php │ ├── MissingInvoiceBillingDetailsThrowable.php │ ├── NotOpenCheckout.php │ ├── NotOpenCheckoutThrowable.php │ ├── NotPaidOrder.php │ ├── NotPaidOrderThrowable.php │ ├── NotPermitted.php │ ├── NotPermittedThrowable.php │ ├── PaymentError.php │ ├── PaymentErrorThrowable.php │ ├── RefundAmountTooHigh.php │ ├── RefundAmountTooHighThrowable.php │ ├── RefundedAlready.php │ ├── RefundedAlreadyThrowable.php │ ├── ResourceNotFound.php │ ├── ResourceNotFoundThrowable.php │ ├── Unauthorized.php │ └── UnauthorizedThrowable.php ├── Operations │ ├── BenefitsCreateResponse.php │ ├── BenefitsDeleteRequest.php │ ├── BenefitsDeleteResponse.php │ ├── BenefitsGetRequest.php │ ├── BenefitsGetResponse.php │ ├── BenefitsGrantsRequest.php │ ├── BenefitsGrantsResponse.php │ ├── BenefitsListRequest.php │ ├── BenefitsListResponse.php │ ├── BenefitsUpdateRequest.php │ ├── BenefitsUpdateResponse.php │ ├── CheckoutLinksCreateResponse.php │ ├── CheckoutLinksDeleteRequest.php │ ├── CheckoutLinksDeleteResponse.php │ ├── CheckoutLinksGetRequest.php │ ├── CheckoutLinksGetResponse.php │ ├── CheckoutLinksListRequest.php │ ├── CheckoutLinksListResponse.php │ ├── CheckoutLinksUpdateRequest.php │ ├── CheckoutLinksUpdateResponse.php │ ├── CheckoutsClientConfirmRequest.php │ ├── CheckoutsClientConfirmResponse.php │ ├── CheckoutsClientGetRequest.php │ ├── CheckoutsClientGetResponse.php │ ├── CheckoutsClientUpdateRequest.php │ ├── CheckoutsClientUpdateResponse.php │ ├── CheckoutsCreateResponse.php │ ├── CheckoutsGetRequest.php │ ├── CheckoutsGetResponse.php │ ├── CheckoutsListRequest.php │ ├── CheckoutsListResponse.php │ ├── CheckoutsUpdateRequest.php │ ├── CheckoutsUpdateResponse.php │ ├── CustomFieldsCreateResponse.php │ ├── CustomFieldsDeleteRequest.php │ ├── CustomFieldsDeleteResponse.php │ ├── CustomFieldsGetRequest.php │ ├── CustomFieldsGetResponse.php │ ├── CustomFieldsListRequest.php │ ├── CustomFieldsListResponse.php │ ├── CustomFieldsUpdateRequest.php │ ├── CustomFieldsUpdateResponse.php │ ├── CustomerMetersGetRequest.php │ ├── CustomerMetersGetResponse.php │ ├── CustomerMetersListRequest.php │ ├── CustomerMetersListResponse.php │ ├── CustomerPortalBenefitGrantsGetRequest.php │ ├── CustomerPortalBenefitGrantsGetResponse.php │ ├── CustomerPortalBenefitGrantsGetSecurity.php │ ├── CustomerPortalBenefitGrantsListRequest.php │ ├── CustomerPortalBenefitGrantsListResponse.php │ ├── CustomerPortalBenefitGrantsListSecurity.php │ ├── CustomerPortalBenefitGrantsUpdateRequest.php │ ├── CustomerPortalBenefitGrantsUpdateResponse.php │ ├── CustomerPortalBenefitGrantsUpdateSecurity.php │ ├── CustomerPortalCustomerMetersGetRequest.php │ ├── CustomerPortalCustomerMetersGetResponse.php │ ├── CustomerPortalCustomerMetersGetSecurity.php │ ├── CustomerPortalCustomerMetersListRequest.php │ ├── CustomerPortalCustomerMetersListResponse.php │ ├── CustomerPortalCustomerMetersListSecurity.php │ ├── CustomerPortalCustomersAddPaymentMethodResponse.php │ ├── CustomerPortalCustomersAddPaymentMethodSecurity.php │ ├── CustomerPortalCustomersDeletePaymentMethodRequest.php │ ├── CustomerPortalCustomersDeletePaymentMethodResponse.php │ ├── CustomerPortalCustomersDeletePaymentMethodSecurity.php │ ├── CustomerPortalCustomersGetPaymentMethodsRequest.php │ ├── CustomerPortalCustomersGetPaymentMethodsResponse.php │ ├── CustomerPortalCustomersGetPaymentMethodsSecurity.php │ ├── CustomerPortalCustomersGetResponse.php │ ├── CustomerPortalCustomersGetSecurity.php │ ├── CustomerPortalCustomersUpdateResponse.php │ ├── CustomerPortalCustomersUpdateSecurity.php │ ├── CustomerPortalDownloadablesCustomerPortalDownloadablesGetRequest.php │ ├── CustomerPortalDownloadablesCustomerPortalDownloadablesGetResponse.php │ ├── CustomerPortalDownloadablesListRequest.php │ ├── CustomerPortalDownloadablesListResponse.php │ ├── CustomerPortalDownloadablesListSecurity.php │ ├── CustomerPortalLicenseKeysActivateResponse.php │ ├── CustomerPortalLicenseKeysDeactivateResponse.php │ ├── CustomerPortalLicenseKeysGetRequest.php │ ├── CustomerPortalLicenseKeysGetResponse.php │ ├── CustomerPortalLicenseKeysGetSecurity.php │ ├── CustomerPortalLicenseKeysListRequest.php │ ├── CustomerPortalLicenseKeysListResponse.php │ ├── CustomerPortalLicenseKeysListSecurity.php │ ├── CustomerPortalLicenseKeysValidateResponse.php │ ├── CustomerPortalOrdersGenerateInvoiceRequest.php │ ├── CustomerPortalOrdersGenerateInvoiceResponse.php │ ├── CustomerPortalOrdersGenerateInvoiceSecurity.php │ ├── CustomerPortalOrdersGetRequest.php │ ├── CustomerPortalOrdersGetResponse.php │ ├── CustomerPortalOrdersGetSecurity.php │ ├── CustomerPortalOrdersInvoiceRequest.php │ ├── CustomerPortalOrdersInvoiceResponse.php │ ├── CustomerPortalOrdersInvoiceSecurity.php │ ├── CustomerPortalOrdersListRequest.php │ ├── CustomerPortalOrdersListResponse.php │ ├── CustomerPortalOrdersListSecurity.php │ ├── CustomerPortalOrdersUpdateRequest.php │ ├── CustomerPortalOrdersUpdateResponse.php │ ├── CustomerPortalOrdersUpdateSecurity.php │ ├── CustomerPortalOrganizationsGetRequest.php │ ├── CustomerPortalOrganizationsGetResponse.php │ ├── CustomerPortalSubscriptionsCancelRequest.php │ ├── CustomerPortalSubscriptionsCancelResponse.php │ ├── CustomerPortalSubscriptionsCancelSecurity.php │ ├── CustomerPortalSubscriptionsGetRequest.php │ ├── CustomerPortalSubscriptionsGetResponse.php │ ├── CustomerPortalSubscriptionsGetSecurity.php │ ├── CustomerPortalSubscriptionsListRequest.php │ ├── CustomerPortalSubscriptionsListResponse.php │ ├── CustomerPortalSubscriptionsListSecurity.php │ ├── CustomerPortalSubscriptionsUpdateRequest.php │ ├── CustomerPortalSubscriptionsUpdateResponse.php │ ├── CustomerPortalSubscriptionsUpdateSecurity.php │ ├── CustomerSessionsCreateResponse.php │ ├── CustomersCreateResponse.php │ ├── CustomersDeleteExternalRequest.php │ ├── CustomersDeleteExternalResponse.php │ ├── CustomersDeleteRequest.php │ ├── CustomersDeleteResponse.php │ ├── CustomersGetExternalRequest.php │ ├── CustomersGetExternalResponse.php │ ├── CustomersGetRequest.php │ ├── CustomersGetResponse.php │ ├── CustomersGetStateExternalRequest.php │ ├── CustomersGetStateExternalResponse.php │ ├── CustomersGetStateRequest.php │ ├── CustomersGetStateResponse.php │ ├── CustomersListRequest.php │ ├── CustomersListResponse.php │ ├── CustomersUpdateExternalRequest.php │ ├── CustomersUpdateExternalResponse.php │ ├── CustomersUpdateRequest.php │ ├── CustomersUpdateResponse.php │ ├── DiscountsCreateResponse.php │ ├── DiscountsDeleteRequest.php │ ├── DiscountsDeleteResponse.php │ ├── DiscountsGetRequest.php │ ├── DiscountsGetResponse.php │ ├── DiscountsListRequest.php │ ├── DiscountsListResponse.php │ ├── DiscountsUpdateRequest.php │ ├── DiscountsUpdateResponse.php │ ├── EventsGetRequest.php │ ├── EventsGetResponse.php │ ├── EventsIngestResponse.php │ ├── EventsListNamesRequest.php │ ├── EventsListNamesResponse.php │ ├── EventsListRequest.php │ ├── EventsListResponse.php │ ├── FilesCreateResponse.php │ ├── FilesDeleteRequest.php │ ├── FilesDeleteResponse.php │ ├── FilesListRequest.php │ ├── FilesListResponse.php │ ├── FilesUpdateRequest.php │ ├── FilesUpdateResponse.php │ ├── FilesUploadedRequest.php │ ├── FilesUploadedResponse.php │ ├── LicenseKeysGetActivationRequest.php │ ├── LicenseKeysGetActivationResponse.php │ ├── LicenseKeysGetRequest.php │ ├── LicenseKeysGetResponse.php │ ├── LicenseKeysListRequest.php │ ├── LicenseKeysListResponse.php │ ├── LicenseKeysUpdateRequest.php │ ├── LicenseKeysUpdateResponse.php │ ├── MetersCreateResponse.php │ ├── MetersGetRequest.php │ ├── MetersGetResponse.php │ ├── MetersListRequest.php │ ├── MetersListResponse.php │ ├── MetersQuantitiesRequest.php │ ├── MetersQuantitiesResponse.php │ ├── MetersUpdateRequest.php │ ├── MetersUpdateResponse.php │ ├── MetricsGetRequest.php │ ├── MetricsGetResponse.php │ ├── MetricsLimitsResponse.php │ ├── Oauth2AuthorizeResponse.php │ ├── Oauth2ClientsListRequest.php │ ├── Oauth2ClientsListResponse.php │ ├── Oauth2ClientsOauth2CreateClientResponse.php │ ├── Oauth2ClientsOauth2DeleteClientRequest.php │ ├── Oauth2ClientsOauth2DeleteClientResponse.php │ ├── Oauth2ClientsOauth2GetClientRequest.php │ ├── Oauth2ClientsOauth2GetClientResponse.php │ ├── Oauth2ClientsOauth2UpdateClientRequest.php │ ├── Oauth2ClientsOauth2UpdateClientResponse.php │ ├── Oauth2IntrospectTokenResponse.php │ ├── Oauth2RequestTokenResponse.php │ ├── Oauth2RevokeTokenResponse.php │ ├── Oauth2UserinfoResponse.php │ ├── OrdersGenerateInvoiceRequest.php │ ├── OrdersGenerateInvoiceResponse.php │ ├── OrdersGetRequest.php │ ├── OrdersGetResponse.php │ ├── OrdersInvoiceRequest.php │ ├── OrdersInvoiceResponse.php │ ├── OrdersListRequest.php │ ├── OrdersListResponse.php │ ├── OrdersUpdateRequest.php │ ├── OrdersUpdateResponse.php │ ├── OrganizationsCreateResponse.php │ ├── OrganizationsGetRequest.php │ ├── OrganizationsGetResponse.php │ ├── OrganizationsListRequest.php │ ├── OrganizationsListResponse.php │ ├── OrganizationsUpdateRequest.php │ ├── OrganizationsUpdateResponse.php │ ├── PaymentsGetRequest.php │ ├── PaymentsGetResponse.php │ ├── PaymentsListRequest.php │ ├── PaymentsListResponse.php │ ├── ProductsCreateResponse.php │ ├── ProductsGetRequest.php │ ├── ProductsGetResponse.php │ ├── ProductsListRequest.php │ ├── ProductsListResponse.php │ ├── ProductsUpdateBenefitsRequest.php │ ├── ProductsUpdateBenefitsResponse.php │ ├── ProductsUpdateRequest.php │ ├── ProductsUpdateResponse.php │ ├── RefundsCreateResponse.php │ ├── RefundsListRequest.php │ ├── RefundsListResponse.php │ ├── SubscriptionsExportRequest.php │ ├── SubscriptionsExportResponse.php │ ├── SubscriptionsGetRequest.php │ ├── SubscriptionsGetResponse.php │ ├── SubscriptionsListRequest.php │ ├── SubscriptionsListResponse.php │ ├── SubscriptionsRevokeRequest.php │ ├── SubscriptionsRevokeResponse.php │ ├── SubscriptionsUpdateRequest.php │ └── SubscriptionsUpdateResponse.php └── Webhooks │ ├── EndpointbenefitCreatedPostResponse.php │ ├── EndpointbenefitGrantCreatedPostResponse.php │ ├── EndpointbenefitGrantCycledPostResponse.php │ ├── EndpointbenefitGrantRevokedPostResponse.php │ ├── EndpointbenefitGrantUpdatedPostResponse.php │ ├── EndpointbenefitUpdatedPostResponse.php │ ├── EndpointcheckoutCreatedPostResponse.php │ ├── EndpointcheckoutUpdatedPostResponse.php │ ├── EndpointcustomerCreatedPostResponse.php │ ├── EndpointcustomerDeletedPostResponse.php │ ├── EndpointcustomerStateChangedPostResponse.php │ ├── EndpointcustomerUpdatedPostResponse.php │ ├── EndpointorderCreatedPostResponse.php │ ├── EndpointorderPaidPostResponse.php │ ├── EndpointorderRefundedPostResponse.php │ ├── EndpointorderUpdatedPostResponse.php │ ├── EndpointorganizationUpdatedPostResponse.php │ ├── EndpointproductCreatedPostResponse.php │ ├── EndpointproductUpdatedPostResponse.php │ ├── EndpointrefundCreatedPostResponse.php │ ├── EndpointrefundUpdatedPostResponse.php │ ├── EndpointsubscriptionActivePostResponse.php │ ├── EndpointsubscriptionCanceledPostResponse.php │ ├── EndpointsubscriptionCreatedPostResponse.php │ ├── EndpointsubscriptionRevokedPostResponse.php │ ├── EndpointsubscriptionUncanceledPostResponse.php │ └── EndpointsubscriptionUpdatedPostResponse.php ├── Oauth2.php ├── Orders.php ├── Organizations.php ├── PackageServiceProvider.php ├── Payments.php ├── Polar.php ├── PolarBuilder.php ├── PolarCustomerMeters.php ├── PolarCustomers.php ├── PolarLicenseKeys.php ├── PolarOrders.php ├── PolarOrganizations.php ├── PolarSubscriptions.php ├── Products.php ├── Refunds.php ├── SDKConfiguration.php ├── Subscriptions.php └── Utils ├── BigDecimalHandler.php ├── BigIntHandler.php ├── DateHandler.php ├── DateTimeHandler.php ├── DefaultRequest.php ├── DefaultResponse.php ├── DefaultStream.php ├── DefaultUri.php ├── EnumHandler.php ├── FormMetadata.php ├── Headers.php ├── JSON.php ├── MixedJSONHandler.php ├── MultipartMetadata.php ├── Options.php ├── ParamsMetadata.php ├── PathParameters.php ├── PhpDocTypeParser.php ├── QueryParameters.php ├── RequestBodies.php ├── RequestMetadata.php ├── Retry ├── PermanentError.php ├── RetryConfig.php ├── RetryConfigBackoff.php ├── RetryConfigNone.php ├── RetryStrategy.php ├── RetryUtils.php └── TemporaryError.php ├── Security.php ├── SecurityClient.php ├── SecurityMetadata.php ├── ServerDetails.php ├── SpeakeasyMetadata.php ├── UnionHandler.php └── Utils.php /.gitattributes: -------------------------------------------------------------------------------- 1 | # This allows generated code to be indexed correctly 2 | *.php linguist-generated=false -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **/.speakeasy/temp/ 2 | **/.speakeasy/logs/ 3 | .speakeasy/temp/ 4 | composer.lock 5 | vendor 6 | .DS_Store 7 | -------------------------------------------------------------------------------- /config/services.php: -------------------------------------------------------------------------------- 1 | [ 9 | 'access_token' => env('ACCESS_TOKEN') 10 | ], 11 | ]; -------------------------------------------------------------------------------- /docs/Models/Components/ActiveSubscriptions.md: -------------------------------------------------------------------------------- 1 | # ActiveSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/AuthorizeOrganization.md: -------------------------------------------------------------------------------- 1 | # AuthorizeOrganization 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | 9 | | `slug` | *string* | :heavy_check_mark: | N/A | 10 | | `avatarUrl` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/AuthorizeUser.md: -------------------------------------------------------------------------------- 1 | # AuthorizeUser 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | 9 | | `email` | *string* | :heavy_check_mark: | N/A | 10 | | `avatarUrl` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/AverageOrderValue.md: -------------------------------------------------------------------------------- 1 | # AverageOrderValue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomCreateProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomCreateProperties 2 | 3 | Properties for creating a benefit of type `custom`. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------ | ------------------ | ------------------ | ------------------ | 10 | | `note` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomMetadata.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomProperties 2 | 3 | Properties for a benefit of type `custom`. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------ | ------------------ | ------------------ | ------------------ | 10 | | `note` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomSubscriberProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomSubscriberProperties 2 | 3 | Properties available to subscribers for a benefit of type `custom`. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------ | ------------------ | ------------------ | ------------------ | 10 | | `note` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitCustomUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # BenefitCustomUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitDiscordMetadata.md: -------------------------------------------------------------------------------- 1 | # BenefitDiscordMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitDiscordSubscriberProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitDiscordSubscriberProperties 2 | 3 | Properties available to subscribers for a benefit of type `discord`. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | 10 | | `guildId` | *string* | :heavy_check_mark: | The ID of the Discord server. | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitDownloadablesCreateProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitDownloadablesCreateProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `archived` | array | :heavy_minus_sign: | N/A | 9 | | `files` | array<*string*> | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitDownloadablesProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitDownloadablesProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `archived` | array | :heavy_check_mark: | N/A | 9 | | `files` | array<*string*> | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitDownloadablesSubscriberProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitDownloadablesSubscriberProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `activeFiles` | array<*string*> | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantCustomProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantCustomProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantDiscordProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantDiscordProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `accountId` | *?string* | :heavy_minus_sign: | N/A | 9 | | `guildId` | *?string* | :heavy_minus_sign: | N/A | 10 | | `roleId` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantDownloadablesProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantDownloadablesProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `files` | array<*string*> | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantError.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `message` | *string* | :heavy_check_mark: | N/A | 9 | | `type` | *string* | :heavy_check_mark: | N/A | 10 | | `timestamp` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantGitHubRepositoryPropertiesPermission.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantGitHubRepositoryPropertiesPermission 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------- | ---------- | 8 | | `Pull` | pull | 9 | | `Triage` | triage | 10 | | `Push` | push | 11 | | `Maintain` | maintain | 12 | | `Admin` | admin | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitGrantLicenseKeysProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitGrantLicenseKeysProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `licenseKeyId` | *?string* | :heavy_minus_sign: | N/A | 9 | | `displayKey` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitLicenseKeyActivationCreateProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitLicenseKeyActivationCreateProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `limit` | *int* | :heavy_check_mark: | N/A | 9 | | `enableCustomerAdmin` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitLicenseKeyActivationProperties.md: -------------------------------------------------------------------------------- 1 | # BenefitLicenseKeyActivationProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `limit` | *int* | :heavy_check_mark: | N/A | 9 | | `enableCustomerAdmin` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitSortProperty.md: -------------------------------------------------------------------------------- 1 | # BenefitSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------ | ------------------ | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Description` | description | 11 | | `MinusDescription` | -description | -------------------------------------------------------------------------------- /docs/Models/Components/BenefitType.md: -------------------------------------------------------------------------------- 1 | # BenefitType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------ | ------------------ | 8 | | `Custom` | custom | 9 | | `Discord` | discord | 10 | | `GithubRepository` | github_repository | 11 | | `Downloadables` | downloadables | 12 | | `LicenseKeys` | license_keys | 13 | | `MeterCredit` | meter_credit | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # CheckoutCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutLinkMetadata.md: -------------------------------------------------------------------------------- 1 | # CheckoutLinkMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutMetadata.md: -------------------------------------------------------------------------------- 1 | # CheckoutMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutSortProperty.md: -------------------------------------------------------------------------------- 1 | # CheckoutSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `ExpiresAt` | expires_at | 11 | | `MinusExpiresAt` | -expires_at | 12 | | `Status` | status | 13 | | `MinusStatus` | -status | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutStatus.md: -------------------------------------------------------------------------------- 1 | # CheckoutStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `Open` | open | 9 | | `Expired` | expired | 10 | | `Confirmed` | confirmed | 11 | | `Succeeded` | succeeded | 12 | | `Failed` | failed | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # CheckoutUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/Checkouts.md: -------------------------------------------------------------------------------- 1 | # Checkouts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CheckoutsConversion.md: -------------------------------------------------------------------------------- 1 | # CheckoutsConversion 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/Clauses.md: -------------------------------------------------------------------------------- 1 | # Clauses 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\FilterClause` 7 | 8 | ```php 9 | /** 10 | * @var Components\FilterClause 11 | */ 12 | Components\FilterClause $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\Filter` 16 | 17 | ```php 18 | /** 19 | * @var Components\Filter 20 | */ 21 | Components\Filter $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/Conditions.md: -------------------------------------------------------------------------------- 1 | # Conditions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CountAggregation.md: -------------------------------------------------------------------------------- 1 | # CountAggregation 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `func` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CumulativeRevenue.md: -------------------------------------------------------------------------------- 1 | # CumulativeRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldCheckboxProperties.md: -------------------------------------------------------------------------------- 1 | # CustomFieldCheckboxProperties 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `formLabel` | *?string* | :heavy_minus_sign: | N/A | 9 | | `formHelpText` | *?string* | :heavy_minus_sign: | N/A | 10 | | `formPlaceholder` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldData.md: -------------------------------------------------------------------------------- 1 | # CustomFieldData 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `bool` 25 | 26 | ```php 27 | /** 28 | * @var bool 29 | */ 30 | bool $value = /* values here */ 31 | ``` 32 | 33 | ### `\DateTime` 34 | 35 | ```php 36 | /** 37 | * @var \DateTime 38 | */ 39 | \DateTime $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldDateMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomFieldDateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldNumberMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomFieldNumberMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldSelectMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomFieldSelectMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldSelectOption.md: -------------------------------------------------------------------------------- 1 | # CustomFieldSelectOption 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `value` | *string* | :heavy_check_mark: | N/A | 9 | | `label` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldSortProperty.md: -------------------------------------------------------------------------------- 1 | # CustomFieldSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Slug` | slug | 11 | | `MinusSlug` | -slug | 12 | | `Name` | name | 13 | | `MinusName` | -name | 14 | | `Type` | type | 15 | | `MinusType` | -type | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldTextMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomFieldTextMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomFieldType.md: -------------------------------------------------------------------------------- 1 | # CustomFieldType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------- | ---------- | 8 | | `Text` | text | 9 | | `Number` | number | 10 | | `Date` | date | 11 | | `Checkbox` | checkbox | 12 | | `Select` | select | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantCustomUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantCustomUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `benefitType` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantDiscordPropertiesUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantDiscordPropertiesUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `accountId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantDownloadablesUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantDownloadablesUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `benefitType` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantGitHubRepositoryPropertiesUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantGitHubRepositoryPropertiesUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `accountId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantLicenseKeysUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantLicenseKeysUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `benefitType` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantMeterCreditUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantMeterCreditUpdate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `benefitType` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerBenefitGrantSortProperty.md: -------------------------------------------------------------------------------- 1 | # CustomerBenefitGrantSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `GrantedAt` | granted_at | 9 | | `MinusGrantedAt` | -granted_at | 10 | | `Type` | type | 11 | | `MinusType` | -type | 12 | | `Organization` | organization | 13 | | `MinusOrganization` | -organization | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerCancellationReason.md: -------------------------------------------------------------------------------- 1 | # CustomerCancellationReason 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------------- | ----------------- | 8 | | `CustomerService` | customer_service | 9 | | `LowQuality` | low_quality | 10 | | `MissingFeatures` | missing_features | 11 | | `SwitchedService` | switched_service | 12 | | `TooComplex` | too_complex | 13 | | `TooExpensive` | too_expensive | 14 | | `Unused` | unused | 15 | | `Other` | other | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomerCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerCreateTaxId.md: -------------------------------------------------------------------------------- 1 | # CustomerCreateTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomerMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `bool` 25 | 26 | ```php 27 | /** 28 | * @var bool 29 | */ 30 | bool $value = /* values here */ 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerMetadata1.md: -------------------------------------------------------------------------------- 1 | # CustomerMetadata1 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerOrderInvoice.md: -------------------------------------------------------------------------------- 1 | # CustomerOrderInvoice 2 | 3 | Order's invoice data. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 10 | | `url` | *string* | :heavy_check_mark: | The URL to the invoice. | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerPortalCustomerTaxId.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomerTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerPortalOAuthAccount.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOAuthAccount 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `accountId` | *string* | :heavy_check_mark: | N/A | 9 | | `accountUsername` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerSortProperty.md: -------------------------------------------------------------------------------- 1 | # CustomerSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Email` | email | 11 | | `MinusEmail` | -email | 12 | | `Name` | name | 13 | | `MinusName` | -name | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerStateMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomerStateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerStateTaxId.md: -------------------------------------------------------------------------------- 1 | # CustomerStateTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerSubscriptionUpdate.md: -------------------------------------------------------------------------------- 1 | # CustomerSubscriptionUpdate 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\CustomerSubscriptionUpdateProduct` 7 | 8 | ```php 9 | /** 10 | * @var Components\CustomerSubscriptionUpdateProduct 11 | */ 12 | Components\CustomerSubscriptionUpdateProduct $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\CustomerSubscriptionCancel` 16 | 17 | ```php 18 | /** 19 | * @var Components\CustomerSubscriptionCancel 20 | */ 21 | Components\CustomerSubscriptionCancel $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerTaxId.md: -------------------------------------------------------------------------------- 1 | # CustomerTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerUpdateExternalIDTaxID.md: -------------------------------------------------------------------------------- 1 | # CustomerUpdateExternalIDTaxID 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # CustomerUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/CustomerUpdateTaxId.md: -------------------------------------------------------------------------------- 1 | # CustomerUpdateTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/DiscountDuration.md: -------------------------------------------------------------------------------- 1 | # DiscountDuration 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `Once` | once | 9 | | `Forever` | forever | 10 | | `Repeating` | repeating | -------------------------------------------------------------------------------- /docs/Models/Components/DiscountProductMetadata.md: -------------------------------------------------------------------------------- 1 | # DiscountProductMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/DiscountType.md: -------------------------------------------------------------------------------- 1 | # DiscountType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------ | ------------ | 8 | | `Fixed` | fixed | 9 | | `Percentage` | percentage | -------------------------------------------------------------------------------- /docs/Models/Components/DiscountUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # DiscountUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/EventNamesSortProperty.md: -------------------------------------------------------------------------------- 1 | # EventNamesSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------ | ------------------ | 8 | | `Name` | name | 9 | | `MinusName` | -name | 10 | | `Occurrences` | occurrences | 11 | | `MinusOccurrences` | -occurrences | 12 | | `FirstSeen` | first_seen | 13 | | `MinusFirstSeen` | -first_seen | 14 | | `LastSeen` | last_seen | 15 | | `MinusLastSeen` | -last_seen | -------------------------------------------------------------------------------- /docs/Models/Components/EventSortProperty.md: -------------------------------------------------------------------------------- 1 | # EventSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `Timestamp` | timestamp | 9 | | `MinusTimestamp` | -timestamp | -------------------------------------------------------------------------------- /docs/Models/Components/EventSource.md: -------------------------------------------------------------------------------- 1 | # EventSource 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------- | -------- | 8 | | `System` | system | 9 | | `User` | user | -------------------------------------------------------------------------------- /docs/Models/Components/Events.md: -------------------------------------------------------------------------------- 1 | # Events 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\EventCreateCustomer` 7 | 8 | ```php 9 | /** 10 | * @var Components\EventCreateCustomer 11 | */ 12 | Components\EventCreateCustomer $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\EventCreateExternalCustomer` 16 | 17 | ```php 18 | /** 19 | * @var Components\EventCreateExternalCustomer 20 | */ 21 | Components\EventCreateExternalCustomer $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/EventsIngestResponse.md: -------------------------------------------------------------------------------- 1 | # EventsIngestResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | 8 | | `inserted` | *int* | :heavy_check_mark: | Number of events inserted. | -------------------------------------------------------------------------------- /docs/Models/Components/ExistingProductPrice.md: -------------------------------------------------------------------------------- 1 | # ExistingProductPrice 2 | 3 | A price that already exists for this product. 4 | 5 | Useful when updating a product if you want to keep an existing price. 6 | 7 | 8 | ## Fields 9 | 10 | | Field | Type | Required | Description | 11 | | ------------------ | ------------------ | ------------------ | ------------------ | 12 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/FilePatch.md: -------------------------------------------------------------------------------- 1 | # FilePatch 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `name` | *?string* | :heavy_minus_sign: | N/A | 9 | | `version` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/FileServiceTypes.md: -------------------------------------------------------------------------------- 1 | # FileServiceTypes 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------------- | -------------------- | 8 | | `Downloadable` | downloadable | 9 | | `ProductMedia` | product_media | 10 | | `OrganizationAvatar` | organization_avatar | -------------------------------------------------------------------------------- /docs/Models/Components/FilterConjunction.md: -------------------------------------------------------------------------------- 1 | # FilterConjunction 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----- | ----- | 8 | | `And` | and | 9 | | `Or` | or | -------------------------------------------------------------------------------- /docs/Models/Components/FilterOperator.md: -------------------------------------------------------------------------------- 1 | # FilterOperator 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | --------- | --------- | 8 | | `Eq` | eq | 9 | | `Ne` | ne | 10 | | `Gt` | gt | 11 | | `Gte` | gte | 12 | | `Lt` | lt | 13 | | `Lte` | lte | 14 | | `Like` | like | 15 | | `NotLike` | not_like | -------------------------------------------------------------------------------- /docs/Models/Components/Func.md: -------------------------------------------------------------------------------- 1 | # Func 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----- | ----- | 8 | | `Sum` | sum | 9 | | `Max` | max | 10 | | `Min` | min | 11 | | `Avg` | avg | -------------------------------------------------------------------------------- /docs/Models/Components/GrantTypes.md: -------------------------------------------------------------------------------- 1 | # GrantTypes 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `AuthorizationCode` | authorization_code | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/IntrospectTokenRequestTokenTypeHint.md: -------------------------------------------------------------------------------- 1 | # IntrospectTokenRequestTokenTypeHint 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------- | -------------- | 8 | | `AccessToken` | access_token | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/Items.md: -------------------------------------------------------------------------------- 1 | # Items 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\PaymentMethodCard` 7 | 8 | ```php 9 | /** 10 | * @var Components\PaymentMethodCard 11 | */ 12 | Components\PaymentMethodCard $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\PaymentMethodGeneric` 16 | 17 | ```php 18 | /** 19 | * @var Components\PaymentMethodGeneric 20 | */ 21 | Components\PaymentMethodGeneric $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/LicenseKeyActivateMeta.md: -------------------------------------------------------------------------------- 1 | # LicenseKeyActivateMeta 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/LicenseKeyCustomerTaxId.md: -------------------------------------------------------------------------------- 1 | # LicenseKeyCustomerTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/LicenseKeyDeactivate.md: -------------------------------------------------------------------------------- 1 | # LicenseKeyDeactivate 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `key` | *string* | :heavy_check_mark: | N/A | 9 | | `organizationId` | *string* | :heavy_check_mark: | N/A | 10 | | `activationId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/LicenseKeyStatus.md: -------------------------------------------------------------------------------- 1 | # LicenseKeyStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------- | ---------- | 8 | | `Granted` | granted | 9 | | `Revoked` | revoked | 10 | | `Disabled` | disabled | -------------------------------------------------------------------------------- /docs/Models/Components/Loc.md: -------------------------------------------------------------------------------- 1 | # Loc 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/Meta.md: -------------------------------------------------------------------------------- 1 | # Meta 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/Metadata.md: -------------------------------------------------------------------------------- 1 | # Metadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/MeterCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # MeterCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/MeterCreditedMetadata.md: -------------------------------------------------------------------------------- 1 | # MeterCreditedMetadata 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `meterId` | *string* | :heavy_check_mark: | N/A | 9 | | `units` | *int* | :heavy_check_mark: | N/A | 10 | | `rollover` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/MeterMetadata.md: -------------------------------------------------------------------------------- 1 | # MeterMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/MeterResetMetadata.md: -------------------------------------------------------------------------------- 1 | # MeterResetMetadata 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `meterId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/MeterSortProperty.md: -------------------------------------------------------------------------------- 1 | # MeterSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Name` | name | 11 | | `MinusName` | -name | -------------------------------------------------------------------------------- /docs/Models/Components/MeterUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # MeterUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricType.md: -------------------------------------------------------------------------------- 1 | # MetricType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------ | ------------ | 8 | | `Scalar` | scalar | 9 | | `Currency` | currency | 10 | | `Percentage` | percentage | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsActiveSubscriptions.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsActiveSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsAverageOrderValue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsAverageOrderValue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsCheckouts.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsCheckouts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsCheckoutsConversion.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsCheckoutsConversion 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsCumulativeRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsCumulativeRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsMonthlyRecurringRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsMonthlyRecurringRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsNewSubscriptions.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsNewSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsNewSubscriptionsRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsNewSubscriptionsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsOneTimeProducts.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsOneTimeProducts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsOneTimeProductsRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsOneTimeProductsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsOrders.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsOrders 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsRenewedSubscriptions.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsRenewedSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsRenewedSubscriptionsRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsRenewedSubscriptionsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsRevenue.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MetricsTotalsSucceededCheckouts.md: -------------------------------------------------------------------------------- 1 | # MetricsTotalsSucceededCheckouts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/MonthlyRecurringRevenue.md: -------------------------------------------------------------------------------- 1 | # MonthlyRecurringRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/NewSubscriptions.md: -------------------------------------------------------------------------------- 1 | # NewSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/NewSubscriptionsRevenue.md: -------------------------------------------------------------------------------- 1 | # NewSubscriptionsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/OAuth2ClientConfigurationGrantTypes.md: -------------------------------------------------------------------------------- 1 | # OAuth2ClientConfigurationGrantTypes 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `AuthorizationCode` | authorization_code | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/OAuth2ClientConfigurationTokenEndpointAuthMethod.md: -------------------------------------------------------------------------------- 1 | # OAuth2ClientConfigurationTokenEndpointAuthMethod 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `ClientSecretBasic` | client_secret_basic | 9 | | `ClientSecretPost` | client_secret_post | 10 | | `None` | none | -------------------------------------------------------------------------------- /docs/Models/Components/OAuth2ClientConfigurationUpdateGrantTypes.md: -------------------------------------------------------------------------------- 1 | # OAuth2ClientConfigurationUpdateGrantTypes 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `AuthorizationCode` | authorization_code | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod.md: -------------------------------------------------------------------------------- 1 | # OAuth2ClientConfigurationUpdateTokenEndpointAuthMethod 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `ClientSecretBasic` | client_secret_basic | 9 | | `ClientSecretPost` | client_secret_post | 10 | | `None` | none | -------------------------------------------------------------------------------- /docs/Models/Components/OneTimeProducts.md: -------------------------------------------------------------------------------- 1 | # OneTimeProducts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/OneTimeProductsRevenue.md: -------------------------------------------------------------------------------- 1 | # OneTimeProductsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/OrderBillingReason.md: -------------------------------------------------------------------------------- 1 | # OrderBillingReason 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------------- | -------------------- | 8 | | `Purchase` | purchase | 9 | | `SubscriptionCreate` | subscription_create | 10 | | `SubscriptionCycle` | subscription_cycle | 11 | | `SubscriptionUpdate` | subscription_update | -------------------------------------------------------------------------------- /docs/Models/Components/OrderCustomerMetadata.md: -------------------------------------------------------------------------------- 1 | # OrderCustomerMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/OrderCustomerTaxId.md: -------------------------------------------------------------------------------- 1 | # OrderCustomerTaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/OrderInvoice.md: -------------------------------------------------------------------------------- 1 | # OrderInvoice 2 | 3 | Order's invoice data. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 10 | | `url` | *string* | :heavy_check_mark: | The URL to the invoice. | -------------------------------------------------------------------------------- /docs/Models/Components/OrderMetadata.md: -------------------------------------------------------------------------------- 1 | # OrderMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/OrderProductMetadata.md: -------------------------------------------------------------------------------- 1 | # OrderProductMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/OrderStatus.md: -------------------------------------------------------------------------------- 1 | # OrderStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `Pending` | pending | 9 | | `Paid` | paid | 10 | | `Refunded` | refunded | 11 | | `PartiallyRefunded` | partially_refunded | -------------------------------------------------------------------------------- /docs/Models/Components/OrderSubscriptionMetadata.md: -------------------------------------------------------------------------------- 1 | # OrderSubscriptionMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/Orders.md: -------------------------------------------------------------------------------- 1 | # Orders 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/OrganizationSocialPlatforms.md: -------------------------------------------------------------------------------- 1 | # OrganizationSocialPlatforms 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `X` | x | 9 | | `Github` | github | 10 | | `Facebook` | facebook | 11 | | `Instagram` | instagram | 12 | | `Youtube` | youtube | 13 | | `Tiktok` | tiktok | 14 | | `Linkedin` | linkedin | 15 | | `Other` | other | -------------------------------------------------------------------------------- /docs/Models/Components/OrganizationSortProperty.md: -------------------------------------------------------------------------------- 1 | # OrganizationSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Slug` | slug | 11 | | `MinusSlug` | -slug | 12 | | `Name` | name | 13 | | `MinusName` | -name | -------------------------------------------------------------------------------- /docs/Models/Components/Pagination.md: -------------------------------------------------------------------------------- 1 | # Pagination 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `totalCount` | *int* | :heavy_check_mark: | N/A | 9 | | `maxPage` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/Payment.md: -------------------------------------------------------------------------------- 1 | # Payment 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\CardPayment` 7 | 8 | ```php 9 | /** 10 | * @var Components\CardPayment 11 | */ 12 | Components\CardPayment $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\GenericPayment` 16 | 17 | ```php 18 | /** 19 | * @var Components\GenericPayment 20 | */ 21 | Components\GenericPayment $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/PaymentProcessor.md: -------------------------------------------------------------------------------- 1 | # PaymentProcessor 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------- | -------- | 8 | | `Stripe` | stripe | -------------------------------------------------------------------------------- /docs/Models/Components/PaymentSortProperty.md: -------------------------------------------------------------------------------- 1 | # PaymentSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Status` | status | 11 | | `MinusStatus` | -status | 12 | | `Amount` | amount | 13 | | `MinusAmount` | -amount | 14 | | `Method` | method | 15 | | `MinusMethod` | -method | -------------------------------------------------------------------------------- /docs/Models/Components/PaymentStatus.md: -------------------------------------------------------------------------------- 1 | # PaymentStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `Pending` | pending | 9 | | `Succeeded` | succeeded | 10 | | `Failed` | failed | -------------------------------------------------------------------------------- /docs/Models/Components/Permission.md: -------------------------------------------------------------------------------- 1 | # Permission 2 | 3 | The permission level to grant. Read more about roles and their permissions on [GitHub documentation](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role). 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | ---------- | ---------- | 10 | | `Pull` | pull | 11 | | `Triage` | triage | 12 | | `Push` | push | 13 | | `Maintain` | maintain | 14 | | `Admin` | admin | -------------------------------------------------------------------------------- /docs/Models/Components/ProductBillingType.md: -------------------------------------------------------------------------------- 1 | # ProductBillingType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `OneTime` | one_time | 9 | | `Recurring` | recurring | -------------------------------------------------------------------------------- /docs/Models/Components/ProductCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # ProductCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/ProductMetadata.md: -------------------------------------------------------------------------------- 1 | # ProductMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/ProductPriceFreeCreate.md: -------------------------------------------------------------------------------- 1 | # ProductPriceFreeCreate 2 | 3 | Schema to create a free price. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------ | ------------------ | ------------------ | ------------------ | 10 | | `amountType` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/ProductPriceMeter.md: -------------------------------------------------------------------------------- 1 | # ProductPriceMeter 2 | 3 | A meter associated to a metered price. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | 10 | | `id` | *string* | :heavy_check_mark: | The ID of the object. | 11 | | `name` | *string* | :heavy_check_mark: | The name of the meter. | -------------------------------------------------------------------------------- /docs/Models/Components/ProductPriceType.md: -------------------------------------------------------------------------------- 1 | # ProductPriceType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `OneTime` | one_time | 9 | | `Recurring` | recurring | -------------------------------------------------------------------------------- /docs/Models/Components/ProductUpdateMetadata.md: -------------------------------------------------------------------------------- 1 | # ProductUpdateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/RefundCreateMetadata.md: -------------------------------------------------------------------------------- 1 | # RefundCreateMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/RefundMetadata.md: -------------------------------------------------------------------------------- 1 | # RefundMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/RefundReason.md: -------------------------------------------------------------------------------- 1 | # RefundReason 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------------------- | ----------------------- | 8 | | `Duplicate` | duplicate | 9 | | `Fraudulent` | fraudulent | 10 | | `CustomerRequest` | customer_request | 11 | | `ServiceDisruption` | service_disruption | 12 | | `SatisfactionGuarantee` | satisfaction_guarantee | 13 | | `Other` | other | -------------------------------------------------------------------------------- /docs/Models/Components/RefundSortProperty.md: -------------------------------------------------------------------------------- 1 | # RefundSortProperty 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------------- | ---------------- | 8 | | `CreatedAt` | created_at | 9 | | `MinusCreatedAt` | -created_at | 10 | | `Amount` | amount | 11 | | `MinusAmount` | -amount | -------------------------------------------------------------------------------- /docs/Models/Components/RefundStatus.md: -------------------------------------------------------------------------------- 1 | # RefundStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `Pending` | pending | 9 | | `Succeeded` | succeeded | 10 | | `Failed` | failed | 11 | | `Canceled` | canceled | -------------------------------------------------------------------------------- /docs/Models/Components/RenewedSubscriptions.md: -------------------------------------------------------------------------------- 1 | # RenewedSubscriptions 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/RenewedSubscriptionsRevenue.md: -------------------------------------------------------------------------------- 1 | # RenewedSubscriptionsRevenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/Revenue.md: -------------------------------------------------------------------------------- 1 | # Revenue 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/RevokeTokenResponse.md: -------------------------------------------------------------------------------- 1 | # RevokeTokenResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/Models/Components/Security.md: -------------------------------------------------------------------------------- 1 | # Security 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `accessToken` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/SubType.md: -------------------------------------------------------------------------------- 1 | # SubType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------- | -------------- | 8 | | `User` | user | 9 | | `Organization` | organization | -------------------------------------------------------------------------------- /docs/Models/Components/SubscriptionProrationBehavior.md: -------------------------------------------------------------------------------- 1 | # SubscriptionProrationBehavior 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | --------- | --------- | 8 | | `Invoice` | invoice | 9 | | `Prorate` | prorate | -------------------------------------------------------------------------------- /docs/Models/Components/SubscriptionRecurringInterval.md: -------------------------------------------------------------------------------- 1 | # SubscriptionRecurringInterval 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------- | ------- | 8 | | `Month` | month | 9 | | `Year` | year | -------------------------------------------------------------------------------- /docs/Models/Components/SubscriptionStatus.md: -------------------------------------------------------------------------------- 1 | # SubscriptionStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `Incomplete` | incomplete | 9 | | `IncompleteExpired` | incomplete_expired | 10 | | `Trialing` | trialing | 11 | | `Active` | active | 12 | | `PastDue` | past_due | 13 | | `Canceled` | canceled | 14 | | `Unpaid` | unpaid | -------------------------------------------------------------------------------- /docs/Models/Components/SucceededCheckouts.md: -------------------------------------------------------------------------------- 1 | # SucceededCheckouts 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `int` 7 | 8 | ```php 9 | /** 10 | * @var int 11 | */ 12 | int $value = /* values here */ 13 | ``` 14 | 15 | ### `float` 16 | 17 | ```php 18 | /** 19 | * @var float 20 | */ 21 | float $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/SwitchingFrom.md: -------------------------------------------------------------------------------- 1 | # SwitchingFrom 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------- | -------------- | 8 | | `Paddle` | paddle | 9 | | `LemonSqueezy` | lemon_squeezy | 10 | | `Gumroad` | gumroad | 11 | | `Stripe` | stripe | 12 | | `Other` | other | -------------------------------------------------------------------------------- /docs/Models/Components/TaxId.md: -------------------------------------------------------------------------------- 1 | # TaxId 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\TaxIDFormat` 16 | 17 | ```php 18 | /** 19 | * @var Components\TaxIDFormat 20 | */ 21 | Components\TaxIDFormat $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Components/TimeInterval.md: -------------------------------------------------------------------------------- 1 | # TimeInterval 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------- | ------- | 8 | | `Year` | year | 9 | | `Month` | month | 10 | | `Week` | week | 11 | | `Day` | day | 12 | | `Hour` | hour | -------------------------------------------------------------------------------- /docs/Models/Components/Timeframe.md: -------------------------------------------------------------------------------- 1 | # Timeframe 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------- | ------- | 8 | | `Year` | year | 9 | | `Month` | month | 10 | | `Day` | day | -------------------------------------------------------------------------------- /docs/Models/Components/TokenEndpointAuthMethod.md: -------------------------------------------------------------------------------- 1 | # TokenEndpointAuthMethod 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------- | ------------------- | 8 | | `ClientSecretBasic` | client_secret_basic | 9 | | `ClientSecretPost` | client_secret_post | 10 | | `None` | none | -------------------------------------------------------------------------------- /docs/Models/Components/TokenType.md: -------------------------------------------------------------------------------- 1 | # TokenType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------- | -------------- | 8 | | `AccessToken` | access_token | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/TokenTypeHint.md: -------------------------------------------------------------------------------- 1 | # TokenTypeHint 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------- | -------------- | 8 | | `AccessToken` | access_token | 9 | | `RefreshToken` | refresh_token | -------------------------------------------------------------------------------- /docs/Models/Components/UnitAmount.md: -------------------------------------------------------------------------------- 1 | # UnitAmount 2 | 3 | The price per unit in cents. Supports up to 12 decimal places. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `float` 9 | 10 | ```php 11 | /** 12 | * @var float 13 | */ 14 | float $value = /* values here */ 15 | ``` 16 | 17 | ### `string` 18 | 19 | ```php 20 | /** 21 | * @var string 22 | */ 23 | string $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Components/UserEventMetadata.md: -------------------------------------------------------------------------------- 1 | # UserEventMetadata 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `float` 25 | 26 | ```php 27 | /** 28 | * @var float 29 | */ 30 | float $value = /* values here */ 31 | ``` 32 | 33 | ### `bool` 34 | 35 | ```php 36 | /** 37 | * @var bool 38 | */ 39 | bool $value = /* values here */ 40 | ``` 41 | 42 | -------------------------------------------------------------------------------- /docs/Models/Components/UserInfoOrganization.md: -------------------------------------------------------------------------------- 1 | # UserInfoOrganization 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `sub` | *string* | :heavy_check_mark: | N/A | 9 | | `name` | *?string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/Models/Components/Value.md: -------------------------------------------------------------------------------- 1 | # Value 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```php 9 | /** 10 | * @var string 11 | */ 12 | string $value = /* values here */ 13 | ``` 14 | 15 | ### `int` 16 | 17 | ```php 18 | /** 19 | * @var int 20 | */ 21 | int $value = /* values here */ 22 | ``` 23 | 24 | ### `bool` 25 | 26 | ```php 27 | /** 28 | * @var bool 29 | */ 30 | bool $value = /* values here */ 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /docs/Models/Errors/CheckoutForbiddenError.md: -------------------------------------------------------------------------------- 1 | # CheckoutForbiddenError 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Errors\AlreadyActiveSubscriptionError` 7 | 8 | ```php 9 | /** 10 | * @var Errors\AlreadyActiveSubscriptionError 11 | */ 12 | Errors\AlreadyActiveSubscriptionError $value = /* values here */ 13 | ``` 14 | 15 | ### `Errors\NotOpenCheckout` 16 | 17 | ```php 18 | /** 19 | * @var Errors\NotOpenCheckout 20 | */ 21 | Errors\NotOpenCheckout $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Errors/ExpiredCheckoutError.md: -------------------------------------------------------------------------------- 1 | # ExpiredCheckoutError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `error` | *string* | :heavy_check_mark: | N/A | ExpiredCheckoutError | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/InvoiceAlreadyExists.md: -------------------------------------------------------------------------------- 1 | # InvoiceAlreadyExists 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `error` | *string* | :heavy_check_mark: | N/A | InvoiceAlreadyExists | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/NotOpenCheckout.md: -------------------------------------------------------------------------------- 1 | # NotOpenCheckout 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | NotOpenCheckout | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/NotPermitted.md: -------------------------------------------------------------------------------- 1 | # NotPermitted 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | NotPermitted | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/PaymentError.md: -------------------------------------------------------------------------------- 1 | # PaymentError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | PaymentError | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/RefundAmountTooHigh.md: -------------------------------------------------------------------------------- 1 | # RefundAmountTooHigh 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | 8 | | `error` | *string* | :heavy_check_mark: | N/A | RefundAmountTooHigh | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/RefundedAlready.md: -------------------------------------------------------------------------------- 1 | # RefundedAlready 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | RefundedAlready | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/ResourceNotFound.md: -------------------------------------------------------------------------------- 1 | # ResourceNotFound 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | ResourceNotFound | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Errors/Unauthorized.md: -------------------------------------------------------------------------------- 1 | # Unauthorized 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `error` | *string* | :heavy_check_mark: | N/A | Unauthorized | 9 | | `detail` | *string* | :heavy_check_mark: | N/A | | -------------------------------------------------------------------------------- /docs/Models/Operations/BenefitIDFilter.md: -------------------------------------------------------------------------------- 1 | # BenefitIDFilter 2 | 3 | Filter products granting specific benefit. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/BenefitTypeFilter.md: -------------------------------------------------------------------------------- 1 | # BenefitTypeFilter 2 | 3 | Filter by benefit type. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\BenefitType` 9 | 10 | ```php 11 | /** 12 | * @var Components\BenefitType 13 | */ 14 | Components\BenefitType $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/BenefitsDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # BenefitsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/BenefitsGetRequest.md: -------------------------------------------------------------------------------- 1 | # BenefitsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutIDFilter 2 | 3 | Filter by checkout ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutLinksDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # CheckoutLinksDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The checkout link ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutLinksGetRequest.md: -------------------------------------------------------------------------------- 1 | # CheckoutLinksGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The checkout link ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutLinksListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutLinksListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutLinksListQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutLinksListQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutsClientGetRequest.md: -------------------------------------------------------------------------------- 1 | # CheckoutsClientGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | 8 | | `clientSecret` | *string* | :heavy_check_mark: | The checkout session client secret. | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutsGetRequest.md: -------------------------------------------------------------------------------- 1 | # CheckoutsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The checkout session ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutsListQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutsListQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CheckoutsListQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # CheckoutsListQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomFieldTypeFilter.md: -------------------------------------------------------------------------------- 1 | # CustomFieldTypeFilter 2 | 3 | Filter by custom field type. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\CustomFieldType` 9 | 10 | ```php 11 | /** 12 | * @var Components\CustomFieldType 13 | */ 14 | Components\CustomFieldType $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomFieldsDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # CustomFieldsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The custom field ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomFieldsGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomFieldsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The custom field ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomFieldsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomFieldsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerEmailFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerEmailFilter 2 | 3 | Filter by customer email. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerMetersGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerMetersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The customer meter ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerMetersListQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerMetersListQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerMetersListQueryParamExternalCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerMetersListQueryParamExternalCustomerIDFilter 2 | 3 | Filter by external customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerMetersListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerMetersListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The benefit grant ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter 2 | 3 | Filter by benefit ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalBenefitGrantsUpdateSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalBenefitGrantsUpdateSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomerMetersGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomerMetersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The customer meter ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomerMetersGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomerMetersGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomerMetersListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomerMetersListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersAddPaymentMethodSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersAddPaymentMethodSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersDeletePaymentMethodRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersDeletePaymentMethodRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersDeletePaymentMethodSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersDeletePaymentMethodSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersGetPaymentMethodsSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersGetPaymentMethodsSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalCustomersUpdateSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalCustomersUpdateSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalDownloadablesCustomerPortalDownloadablesGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalDownloadablesCustomerPortalDownloadablesGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `token` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalDownloadablesListQueryParamBenefitIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalDownloadablesListQueryParamBenefitIDFilter 2 | 3 | Filter by benefit ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalDownloadablesListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalDownloadablesListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalDownloadablesListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalDownloadablesListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalLicenseKeysGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalLicenseKeysGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalLicenseKeysGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalLicenseKeysGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalLicenseKeysListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalLicenseKeysListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalLicenseKeysListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalLicenseKeysListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersGenerateInvoiceRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersGenerateInvoiceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersGenerateInvoiceSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersGenerateInvoiceSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersInvoiceRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersInvoiceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersInvoiceSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersInvoiceSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersListQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersListQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersListQueryParamSubscriptionIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersListQueryParamSubscriptionIDFilter 2 | 3 | Filter by subscription ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrdersUpdateSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrdersUpdateSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalOrganizationsGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalOrganizationsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | 8 | | `slug` | *string* | :heavy_check_mark: | The organization slug. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsCancelRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsCancelRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The subscription ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsCancelSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsCancelSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The subscription ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsGetSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsGetSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsListQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsListQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsListSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsListSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomerPortalSubscriptionsUpdateSecurity.md: -------------------------------------------------------------------------------- 1 | # CustomerPortalSubscriptionsUpdateSecurity 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `customerSession` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersDeleteExternalRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersDeleteExternalRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `externalId` | *string* | :heavy_check_mark: | The customer external ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The customer ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersGetExternalRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersGetExternalRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `externalId` | *string* | :heavy_check_mark: | The customer external ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersGetRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The customer ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersGetStateExternalRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersGetStateExternalRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `externalId` | *string* | :heavy_check_mark: | The customer external ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersGetStateRequest.md: -------------------------------------------------------------------------------- 1 | # CustomersGetStateRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The customer ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/CustomersListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # CustomersListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/DiscountIDFilter.md: -------------------------------------------------------------------------------- 1 | # DiscountIDFilter 2 | 3 | Filter by discount ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/DiscountsDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # DiscountsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The discount ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/DiscountsGetRequest.md: -------------------------------------------------------------------------------- 1 | # DiscountsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The discount ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/DiscountsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # DiscountsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/EventsGetRequest.md: -------------------------------------------------------------------------------- 1 | # EventsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The event ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/EventsListNamesQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # EventsListNamesQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/EventsListNamesQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # EventsListNamesQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/EventsListQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # EventsListQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/EventsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # EventsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/ExternalCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # ExternalCustomerIDFilter 2 | 3 | Filter by external customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/FileIDFilter.md: -------------------------------------------------------------------------------- 1 | # FileIDFilter 2 | 3 | Filter by file ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/FilesDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # FilesDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/FilesListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # FilesListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/LicenseKeysGetActivationRequest.md: -------------------------------------------------------------------------------- 1 | # LicenseKeysGetActivationRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | 9 | | `activationId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/LicenseKeysGetRequest.md: -------------------------------------------------------------------------------- 1 | # LicenseKeysGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/LicenseKeysListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # LicenseKeysListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MeterIDFilter.md: -------------------------------------------------------------------------------- 1 | # MeterIDFilter 2 | 3 | Filter by meter ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetersGetRequest.md: -------------------------------------------------------------------------------- 1 | # MetersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The meter ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/MetersListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetersListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetersQuantitiesQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetersQuantitiesQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetersQuantitiesQueryParamExternalCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetersQuantitiesQueryParamExternalCustomerIDFilter 2 | 3 | Filter by external customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MethodFilter.md: -------------------------------------------------------------------------------- 1 | # MethodFilter 2 | 3 | Filter by payment method. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetricsGetQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetricsGetQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetricsGetQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetricsGetQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/MetricsGetQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # MetricsGetQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/NameFilter.md: -------------------------------------------------------------------------------- 1 | # NameFilter 2 | 3 | Filter by event name. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/Oauth2ClientsOauth2DeleteClientRequest.md: -------------------------------------------------------------------------------- 1 | # Oauth2ClientsOauth2DeleteClientRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `clientId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/Oauth2ClientsOauth2GetClientRequest.md: -------------------------------------------------------------------------------- 1 | # Oauth2ClientsOauth2GetClientRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `clientId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/Oauth2RequestTokenRequestBody.md: -------------------------------------------------------------------------------- 1 | # Oauth2RequestTokenRequestBody 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `Components\AuthorizationCodeTokenRequest` 7 | 8 | ```php 9 | /** 10 | * @var Components\AuthorizationCodeTokenRequest 11 | */ 12 | Components\AuthorizationCodeTokenRequest $value = /* values here */ 13 | ``` 14 | 15 | ### `Components\RefreshTokenRequest` 16 | 17 | ```php 18 | /** 19 | * @var Components\RefreshTokenRequest 20 | */ 21 | Components\RefreshTokenRequest $value = /* values here */ 22 | ``` 23 | 24 | -------------------------------------------------------------------------------- /docs/Models/Operations/Oauth2UserinfoResponseOauth2Userinfo.md: -------------------------------------------------------------------------------- 1 | # Oauth2UserinfoResponseOauth2Userinfo 2 | 3 | Successful Response 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\UserInfoUser` 9 | 10 | ```php 11 | /** 12 | * @var Components\UserInfoUser 13 | */ 14 | Components\UserInfoUser $value = /* values here */ 15 | ``` 16 | 17 | ### `Components\UserInfoOrganization` 18 | 19 | ```php 20 | /** 21 | * @var Components\UserInfoOrganization 22 | */ 23 | Components\UserInfoOrganization $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrderIDFilter.md: -------------------------------------------------------------------------------- 1 | # OrderIDFilter 2 | 3 | Filter by order ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersGenerateInvoiceRequest.md: -------------------------------------------------------------------------------- 1 | # OrdersGenerateInvoiceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersGetRequest.md: -------------------------------------------------------------------------------- 1 | # OrdersGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersInvoiceRequest.md: -------------------------------------------------------------------------------- 1 | # OrdersInvoiceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The order ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersListQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # OrdersListQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # OrdersListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrdersListQueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # OrdersListQueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # OrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/OrganizationId.md: -------------------------------------------------------------------------------- 1 | # OrganizationId 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/PaymentsGetRequest.md: -------------------------------------------------------------------------------- 1 | # PaymentsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | The payment ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/PaymentsListQueryParamCheckoutIDFilter.md: -------------------------------------------------------------------------------- 1 | # PaymentsListQueryParamCheckoutIDFilter 2 | 3 | Filter by checkout ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/PaymentsListQueryParamOrderIDFilter.md: -------------------------------------------------------------------------------- 1 | # PaymentsListQueryParamOrderIDFilter 2 | 3 | Filter by order ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/PaymentsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # PaymentsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/ProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # ProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/ProductsGetRequest.md: -------------------------------------------------------------------------------- 1 | # ProductsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/Models/Operations/ProductsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # ProductsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamBenefitIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamBenefitIDFilter 2 | 3 | Filter by benefit ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamBenefitTypeFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamBenefitTypeFilter 2 | 3 | Filter by benefit type. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\BenefitType` 9 | 10 | ```php 11 | /** 12 | * @var Components\BenefitType 13 | */ 14 | Components\BenefitType $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamCheckoutIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamCheckoutIDFilter 2 | 3 | Filter by checkout ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamCustomerIDFilter 2 | 3 | Filter by customer. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamDiscountIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamDiscountIDFilter 2 | 3 | Filter by discount ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamExternalCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamExternalCustomerIDFilter 2 | 3 | Filter by external customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamMeterIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamMeterIDFilter 2 | 3 | Filter by meter ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamOrderIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamOrderIDFilter 2 | 3 | Filter by order ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamProductIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamProductIDFilter 2 | 3 | Filter by product ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamSourceFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamSourceFilter 2 | 3 | Filter by event source. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\EventSource` 9 | 10 | ```php 11 | /** 12 | * @var Components\EventSource 13 | */ 14 | Components\EventSource $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamStatusFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamStatusFilter 2 | 3 | Filter by payment status. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\PaymentStatus` 9 | 10 | ```php 11 | /** 12 | * @var Components\PaymentStatus 13 | */ 14 | Components\PaymentStatus $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/QueryParamSubscriptionIDFilter.md: -------------------------------------------------------------------------------- 1 | # QueryParamSubscriptionIDFilter 2 | 3 | Filter by subscription ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/RefundIDFilter.md: -------------------------------------------------------------------------------- 1 | # RefundIDFilter 2 | 3 | Filter by refund ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/RefundsListQueryParamCustomerIDFilter.md: -------------------------------------------------------------------------------- 1 | # RefundsListQueryParamCustomerIDFilter 2 | 3 | Filter by customer ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/RefundsListQueryParamOrganizationIDFilter.md: -------------------------------------------------------------------------------- 1 | # RefundsListQueryParamOrganizationIDFilter 2 | 3 | Filter by organization ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/SourceFilter.md: -------------------------------------------------------------------------------- 1 | # SourceFilter 2 | 3 | Filter by event source. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\EventSource` 9 | 10 | ```php 11 | /** 12 | * @var Components\EventSource 13 | */ 14 | Components\EventSource $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/StatusFilter.md: -------------------------------------------------------------------------------- 1 | # StatusFilter 2 | 3 | Filter by checkout session status. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `Components\CheckoutStatus` 9 | 10 | ```php 11 | /** 12 | * @var Components\CheckoutStatus 13 | */ 14 | Components\CheckoutStatus $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/SubscriptionIDFilter.md: -------------------------------------------------------------------------------- 1 | # SubscriptionIDFilter 2 | 3 | Filter by subscription ID. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `string` 9 | 10 | ```php 11 | /** 12 | * @var string 13 | */ 14 | string $value = /* values here */ 15 | ``` 16 | 17 | ### `array` 18 | 19 | ```php 20 | /** 21 | * @var array 22 | */ 23 | array $value = /* values here */ 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /docs/Models/Operations/SubscriptionsGetRequest.md: -------------------------------------------------------------------------------- 1 | # SubscriptionsGetRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The subscription ID. | -------------------------------------------------------------------------------- /docs/Models/Operations/SubscriptionsRevokeRequest.md: -------------------------------------------------------------------------------- 1 | # SubscriptionsRevokeRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------- | -------------------- | -------------------- | -------------------- | 8 | | `id` | *string* | :heavy_check_mark: | The subscription ID. | -------------------------------------------------------------------------------- /docs/sdks/customerportal/README.md: -------------------------------------------------------------------------------- 1 | # CustomerPortal 2 | (*customerPortal*) 3 | 4 | ## Overview 5 | 6 | ### Available Operations 7 | -------------------------------------------------------------------------------- /docs/sdks/polar/README.md: -------------------------------------------------------------------------------- 1 | # Polar SDK 2 | 3 | ## Overview 4 | 5 | Read the docs at https://docs.polar.sh/api-reference 6 | 7 | ### Available Operations 8 | -------------------------------------------------------------------------------- /phpstan.neon: -------------------------------------------------------------------------------- 1 | parameters: 2 | 3 | paths: 4 | - src/ 5 | 6 | reportUnmatchedIgnoredErrors: false 7 | 8 | ignoreErrors: 9 | - '#.*?class ReflectionProperty constructor expects object\|string.*?#' 10 | - '#^Strict comparison using === between .*? will always evaluate to false\.$#' 11 | - identifier: missingType.generics 12 | -------------------------------------------------------------------------------- /src/Hooks/AfterErrorHook.php: -------------------------------------------------------------------------------- 1 | config, $hookCtx->baseURL, $hookCtx->operationID, $hookCtx->oauth2Scopes, $hookCtx->securitySource); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/Hooks/AfterSuccessHook.php: -------------------------------------------------------------------------------- 1 | response = $response; 21 | $this->e = $e; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/Hooks/FailEarlyException.php: -------------------------------------------------------------------------------- 1 | url = $url; 20 | $this->client = $client; 21 | } 22 | } -------------------------------------------------------------------------------- /src/Hooks/TokenResponse.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/HTTPValidationErrorThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/InvoiceAlreadyExistsThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/NotOpenCheckoutThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/NotPaidOrderThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/NotPermittedThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/PaymentErrorThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/RefundAmountTooHighThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/RefundedAlreadyThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/ResourceNotFoundThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Models/Errors/UnauthorizedThrowable.php: -------------------------------------------------------------------------------- 1 | container = $container; 19 | } 20 | } -------------------------------------------------------------------------------- /src/Utils/Retry/PermanentError.php: -------------------------------------------------------------------------------- 1 |