models

package

Versions in this module

v1
Mar 5, 2024
Feb 5, 2024
v0
Oct 17, 2024
Changes in this version
Sep 27, 2024
Changes in this version
type CancellationMethod
type ListProductsFilter
Aug 21, 2024
Changes in this version
type ComponentCustomPrice
type CreateCustomer
type CustomerAttributes
type InvoiceRefund
type PaymentType
type UpdateCustomer
Jun 26, 2024
Changes in this version
Jun 17, 2024
Jun 5, 2024
Changes in this version
type AccountBalance
type AccountBalances
type ActivateSubscriptionRequest
type AddCouponsRequest
type AddSubscriptionToAGroup
type AgreementAcceptance
type AllocateComponents
type AllocationExpirationDate
type AllocationPreview
type AllocationPreviewItem
type AllocationPreviewLineItem
type AllocationPreviewResponse
type AllocationResponse
type AllocationSettings
type AppliedCreditNoteData
type ApplyCreditNoteEventData
type AttributeError
type BankAccountAttributes
type BankAccountPaymentProfile
type BankAccountResponse
type BankAccountVerification
type BankAccountVerificationRequest
type BaseRefundError
type BaseStringError
type BatchJobResponse
type BillingManifest
type BillingManifestItem
type BillingSchedule
type BulkComponentsPricePointAssignment
type BulkCreateProductPricePointsRequest
type BulkCreateProductPricePointsResponse
type BulkCreateSegments
type BulkUpdateSegments
type BulkUpdateSegmentsItem
type CalendarBilling
type CancelGroupedSubscriptionsRequest
type CancellationOptions
type CancellationRequest
type ChangeInvoiceCollectionMethodEventData
type ComponentAllocationChange
type ComponentAllocationErrorItem
type ComponentCostData
type ComponentCostDataRateTier
type ComponentCurrencyPrice
type ComponentCurrencyPricesResponse
type ComponentCustomPrice
type ComponentPrice
type ComponentPricePoint
type ComponentPricePointAssignment
type ComponentPricePointErrorItem
type ComponentPricePointItem
type ComponentPricePointResponse
type ComponentPricePointsResponse
type ComponentResponse
type ConsolidatedInvoice
type CouponCurrency
type CouponCurrencyRequest
type CouponCurrencyResponse
type CouponResponse
type CouponRestriction
type CouponSubcodes
type CouponSubcodesResponse
type CreateAllocation
type CreateAllocationRequest
type CreateComponentPricePoint
type CreateComponentPricePointRequest
type CreateComponentPricePointsRequest
type CreateCurrencyPrice
type CreateCurrencyPricesRequest
type CreateCustomer
type CreateCustomerRequest
type CreateEBBComponent
type CreateInvoiceAddress
type CreateInvoiceCoupon
type CreateInvoiceItem
type CreateInvoicePayment
type CreateInvoicePaymentApplication
type CreateInvoicePaymentRequest
type CreateInvoiceRequest
type CreateMetadata
type CreateMetadataRequest
type CreateMetafield
type CreateMetafieldsRequest
type CreateMeteredComponent
type CreateMultiInvoicePayment
type CreateMultiInvoicePaymentRequest
type CreateOfferRequest
type CreateOnOffComponent
type CreateOrUpdateCoupon
type CreateOrUpdateEndpoint
type CreateOrUpdateEndpointRequest
type CreateOrUpdateFlatAmountCoupon
type CreateOrUpdatePercentageCoupon
type CreateOrUpdateProduct
type CreateOrUpdateProductRequest
type CreateOrUpdateSegmentPrice
type CreatePaymentProfile
type CreatePaymentProfileRequest
type CreatePrepaidComponent
type CreatePrepaidUsageComponentPricePoint
type CreatePrepayment
type CreatePrepaymentRequest
type CreatePrepaymentResponse
type CreateProductCurrencyPrice
type CreateProductCurrencyPricesRequest
type CreateProductFamilyRequest
type CreateProductPricePoint
type CreateProductPricePointRequest
type CreateQuantityBasedComponent
type CreateReasonCode
type CreateReasonCodeRequest
type CreateSegmentRequest
type CreateSubscription
type CreateSubscriptionComponent
type CreateSubscriptionGroup
type CreateSubscriptionGroupRequest
type CreateSubscriptionRequest
type CreateUsageRequest
type CreatedPrepayment
type CreditAccountBalanceChanged
type CreditCardAttributes
type CreditCardPaymentProfile
type CreditNoteApplication
type CreditNoteLineItem
type CreditSchemeRequest
type CurrencyPricesResponse
type CustomFieldValueChange
type CustomerAttributes
type CustomerChange
type CustomerChangesPreviewResponse
type CustomerCustomFieldsChange
type CustomerPayerChange
type CustomerResponse
type DeductServiceCredit
type DeductServiceCreditRequest
type DelayedCancellationResponse
type DeleteSubscriptionGroupResponse
type DunningStepData
type DunningStepReached
type EnableWebhooksRequest
type EnableWebhooksResponse
type EndpointResponse
type EventBasedBillingSegmentError
type FullSubscriptionGroupResponse
type GetOneTimeTokenPaymentProfile
type GetOneTimeTokenRequest
type InvoiceAddress
type InvoiceBalanceItem
type InvoiceCustomField
type InvoiceCustomer
type InvoiceDiscount
type InvoiceDiscountBreakout
type InvoiceDisplaySettings
type InvoiceLineItem
type InvoiceLineItemComponentCostData
type InvoiceLineItemEventData
type InvoiceLineItemPricingDetail
type InvoicePayerChange
type InvoicePayment
type InvoicePaymentApplication
type InvoicePaymentMethod
type InvoicePrePayment
type InvoicePreviousBalance
type InvoiceResponse
type InvoiceTaxBreakout
type InvoiceTaxComponentBreakout
type IssueAdvanceInvoiceRequest
type IssueInvoiceEventData
type IssueInvoiceRequest
type IssueServiceCredit
type IssueServiceCreditRequest
type ItemPricePointChanged
type ItemPricePointData
type ListComponentsPricePointsResponse
type ListCreditNotesResponse
type ListInvoiceEventsResponse
type ListInvoicesResponse
type ListMRRResponse
type ListMRRResponseResult
type ListMetafieldsResponse
type ListOffersResponse
type ListProductPricePointsResponse
type ListProformaInvoicesMeta
type ListProformaInvoicesResponse
type ListPublicKeysMeta
type ListPublicKeysResponse
type ListSaleRepItem
type ListSegmentsResponse
type ListSubcriptionGroupPrepaymentItem
type ListSubscriptionComponentsResponse
type ListSubscriptionGroupPrepayment
type ListSubscriptionGroupPrepaymentResponse
type ListSubscriptionGroupsItem
type ListSubscriptionGroupsMeta
type ListSubscriptionGroupsResponse
type MetafieldScope
type MeteredComponent
type MovementLineItem
type MultiInvoicePayment
type MultiInvoicePaymentResponse
type NestedSubscriptionGroup
type OfferSignupPage
type OnOffComponent
type OrganizationAddress
type OveragePricing
type OverrideSubscription
type OverrideSubscriptionRequest
type PaginatedMetadata
type PayerAttributes
type PaymentCollectionMethodChanged
type PaymentForAllocation
type PaymentMethodApplePay
type PaymentMethodBankAccount
type PaymentMethodCreditCard
type PaymentMethodExternal
type PaymentMethodPaypal
type PaymentProfileAttributes
type PaymentProfileResponse
type PaymentRelatedEvents
type PendingCancellationChange
type PortalManagementLink
type PrepaidComponentPricePoint
type PrepaidConfiguration
type PrepaidConfigurationResponse
type PrepaidSubscriptionBalanceChanged
type PrepaidUsageAllocationDetail
type PrepaidUsageComponent
type PrepaymentAccountBalanceChanged
type PrepaymentResponse
type PrepaymentsResponse
type PreviewAllocationsRequest
type ProductFamilyResponse
type ProductPricePoint
type ProductPricePointErrors
type ProductPricePointResponse
type ProductResponse
type ProformaInvoice
type ProformaInvoiceCredit
type ProformaInvoiceDiscount
type ProformaInvoiceIssued
type ProformaInvoicePayment
type ProformaInvoiceTax
type PublicSignupPage
type QuantityBasedComponent
type ReactivateSubscriptionGroupRequest
type ReactivateSubscriptionGroupResponse
type ReactivateSubscriptionRequest
type ReactivationBilling
type ReasonCodeResponse
type ReasonCodesJsonResponse
type RecordPaymentRequest
type RecordPaymentResponse
type ReferralValidationResponse
type RefundConsolidatedInvoice
type RefundInvoiceEventData
type RefundInvoiceRequest
type RefundPrepayment
type RefundPrepaymentBaseRefundError
type RefundPrepaymentRequest
type RemovePaymentEventData
type RenewalPreview
type RenewalPreviewComponent
type RenewalPreviewLineItem
type RenewalPreviewRequest
type RenewalPreviewResponse
type ReplayWebhooksRequest
type ReplayWebhooksResponse
type ResentInvitation
type RevokedInvitation
type SaleRepItemMrr
type SaleRepSettings
type SaleRepSubscription
type SegmentResponse
type SendInvoiceRequest
type ServiceCreditResponse
type SignupProformaPreview
type SignupProformaPreviewResponse
type SiteStatistics
type SubscriptionComponentAllocationErrorItem
type SubscriptionComponentResponse
type SubscriptionComponentSubscription
type SubscriptionCustomPrice
type SubscriptionGroup
type SubscriptionGroupBalances
type SubscriptionGroupBankAccount
type SubscriptionGroupComponentCustomPrice
type SubscriptionGroupCreditCard
type SubscriptionGroupCustomer
type SubscriptionGroupItem
type SubscriptionGroupMemberError
type SubscriptionGroupMembersArrayError
type SubscriptionGroupPaymentProfile
type SubscriptionGroupPrepayment
type SubscriptionGroupPrepaymentRequest
type SubscriptionGroupPrepaymentResponse
type SubscriptionGroupResponse
type SubscriptionGroupSignup
type SubscriptionGroupSignupComponent
type SubscriptionGroupSignupError
type SubscriptionGroupSignupFailure
type SubscriptionGroupSignupFailureData
type SubscriptionGroupSignupItem
type SubscriptionGroupSignupRequest
type SubscriptionGroupSignupResponse
type SubscriptionGroupSignupSuccess
type SubscriptionGroupSignupSuccessData
type SubscriptionGroupSingleError
type SubscriptionGroupSubscriptionError
type SubscriptionGroupUpdateError
type SubscriptionIncludedCoupon
type SubscriptionMRR
type SubscriptionMRRBreakout
type SubscriptionMRRResponse
type SubscriptionMigrationPreview
type SubscriptionMigrationPreviewOptions
type SubscriptionMigrationPreviewRequest
type SubscriptionMigrationPreviewResponse
type SubscriptionNote
type SubscriptionNoteResponse
type SubscriptionPreview
type SubscriptionPreviewResponse
type SubscriptionProductChange
type SubscriptionProductMigration
type SubscriptionProductMigrationRequest
type SubscriptionResponse
type SubscriptionStateChange
type TaxConfiguration
type TooManyManagementLinkRequests
type UpdateAllocationExpirationDate
type UpdateComponent
type UpdateComponentPricePoint
type UpdateComponentPricePointRequest
type UpdateComponentRequest
type UpdateCouponCurrency
type UpdateCurrencyPrice
type UpdateCurrencyPricesRequest
type UpdateCustomerRequest
type UpdateMetadata
type UpdateMetadataRequest
type UpdateMetafield
type UpdateMetafieldsRequest
type UpdatePaymentProfile
type UpdatePaymentProfileRequest
type UpdateProductPricePoint
type UpdateProductPricePointRequest
type UpdateReasonCode
type UpdateReasonCodeRequest
type UpdateSegmentRequest
type UpdateSubscription
type UpdateSubscriptionComponent
type UpdateSubscriptionGroup
type UpdateSubscriptionGroupRequest
type UpdateSubscriptionNote
type UpdateSubscriptionNoteRequest
type UpdateSubscriptionRequest
type UpsertPrepaidConfiguration
type UpsertPrepaidConfigurationRequest
type VoidInvoiceEventData
type VoidInvoiceRequest
type VoidRemainderEventData
type WebhookResponse
Mar 21, 2024
Changes in this version
type AccountBalances
type CreateInvoicePayment
type InvoiceCustomField
type InvoiceLineItem
type InvoiceTaxBreakout
type ListSubscriptionGroupsItem
type PrepaymentMethod
type ProformaInvoiceDiscount
Jan 26, 2024
Changes in this version

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL