Index

Modules: paddle, paddle/api, paddle/customers, paddle/prices, paddle/products, paddle/subscriptions.

API symbols

`$`:

• api: proc `$`(query: QueryTable): string

active:

• api: PaddleItemStatus.active
• subscriptions: PaddleSubscriptionStatus.active
• subscriptions: PaddleSubscriptionItemStatus.active

ApiResponseData:

• api: object ApiResponseData

archived:

• api: PaddleItemStatus.archived

ARS:

• prices: CurrencyCode.ARS

AUD:

• prices: CurrencyCode.AUD

automatic:

• subscriptions: PaddleCollectionMethod.automatic

BRL:

• prices: CurrencyCode.BRL

CAD:

• prices: CurrencyCode.CAD

cancel:

• subscriptions: PaddleScheduledChangeAction.cancel

canceled:

• subscriptions: PaddleSubscriptionStatus.canceled

CHF:

• prices: CurrencyCode.CHF

CNY:

• prices: CurrencyCode.CNY

COP:

• prices: CurrencyCode.COP

CurrencyCode:

• prices: enum CurrencyCode

custom:

• api: PaddleItemType.custom

CZK:

• prices: CurrencyCode.CZK

day:

• prices: PaddleBillingInterval.day

digitalGoods:

• api: PaddleTaxCategory.digitalGoods

DKK:

• prices: CurrencyCode.DKK

dumpHook:

• api: proc dumpHook(s: var string; v: DateTime)

ebooks:

• api: PaddleTaxCategory.ebooks

EUR:

• prices: CurrencyCode.EUR

GBP:

• prices: CurrencyCode.GBP

genAuthToken:

• customers: proc genAuthToken(client: PaddleClient; customerId: PaddleEntryID): Future[ ApiResponseData[PaddleCustomerToken]]

getCustomer:

• customers: proc getCustomer(client: PaddleClient; id: PaddleEntryID): Future[ PaddleApiResponse[PaddleCustomer]]

getCustomers:

• customers: proc getCustomers(client: PaddleClient): Future[ PaddleApiResponse[seq[PaddleCustomer]]]

getPrices:

• prices: proc getPrices(client: PaddleClient): Future[PaddleApiResponse[seq[PaddlePrice]]]

getProduct:

• products: proc getProduct(client: PaddleClient; id: PaddleEntryID): Future[ PaddleApiResponse[PaddleProduct]]

getProducts:

• products: proc getProducts(client: PaddleClient): Future[PaddleApiResponse[seq[PaddleProduct]]]

getSubscription:

• subscriptions: proc getSubscription(client: PaddleClient; id: PaddleEntryID): Future[ PaddleApiResponse[PaddleSubscription]]

getSubscriptions:

• subscriptions: proc getSubscriptions(client: PaddleClient): Future[ PaddleApiResponse[seq[PaddleSubscription]]]

granted:

• subscriptions: PaddleConsentRequirementStatus.granted

HKD:

• prices: CurrencyCode.HKD

httpGet:

• api: proc httpGet(client: PaddleClient; endpoint: string): Future[AsyncResponse]
• api: proc httpGet(client: PaddleClient; endpoint: string; query: QueryTable): Future[ AsyncResponse]

httpPatch:

• api: proc httpPatch[T](client: PaddleClient; endpoint: string; body: T): Future[ AsyncResponse]

httpPost:

• api: proc httpPost(client: PaddleClient; endpoint: string): Future[AsyncResponse]
• api: proc httpPost[T](client: PaddleClient; endpoint: string; body: T): Future[ AsyncResponse]

HUF:

• prices: CurrencyCode.HUF

ILS:

• prices: CurrencyCode.ILS

implementationServices:

• api: PaddleTaxCategory.implementationServices

inactive:

• subscriptions: PaddleSubscriptionItemStatus.inactive

initBillingCycle:

• prices: proc initBillingCycle(interval: PaddleBillingInterval; frequency: int): PaddleBillingCycle

initPaddleClient:

• api: proc initPaddleClient(apiKey: string): PaddleClient

initPrice:

• prices: proc initPrice(unitPrice: PriceUnit; billingCycle: Option[PaddleBillingCycle] = none(PaddleBillingCycle); trialPeriod: Option[PaddleBillingCycle] = none(PaddleBillingCycle); taxMode: PriceTaxMode = PriceTaxMode.taxModeAccountSetting): PaddlePrice
• prices: proc initPrice(amount: string; currency: CurrencyCode): PriceUnit

INR:

• prices: CurrencyCode.INR

introductoryDiscountEnding:

• subscriptions: PaddleConsentRequirementType.introductoryDiscountEnding

isEmpty:

• api: proc isEmpty[T](response: PaddleApiResponse[seq[T]]): bool

JPY:

• prices: CurrencyCode.JPY

KRW:

• prices: CurrencyCode.KRW

len:

• api: proc len[T](response: PaddleApiResponse[seq[T]]): int

manual:

• subscriptions: PaddleCollectionMethod.manual

month:

• prices: PaddleBillingInterval.month

MXN:

• prices: CurrencyCode.MXN

NOK:

• prices: CurrencyCode.NOK

NZD:

• prices: CurrencyCode.NZD

oneOff:

• subscriptions: PaddleDiscountType.oneOff

PaddleApiResponse:

• api: object PaddleApiResponse

PaddleApiResponseMeta:

• api: object PaddleApiResponseMeta

PaddleApiResponseMetaPagination:

• api: object PaddleApiResponseMetaPagination

PaddleBaseObject:

• api: object PaddleBaseObject

PaddleBillingCycle:

• prices: object PaddleBillingCycle

PaddleBillingDetails:

• subscriptions: object PaddleBillingDetails

PaddleBillingInterval:

• prices: enum PaddleBillingInterval

PaddleClient:

• api: object PaddleClient

PaddleClientError:

• api: object PaddleClientError

PaddleCollectionMethod:

• subscriptions: enum PaddleCollectionMethod

PaddleConsentRequirement:

• subscriptions: object PaddleConsentRequirement

PaddleConsentRequirementStatus:

• subscriptions: enum PaddleConsentRequirementStatus

PaddleConsentRequirementType:

• subscriptions: enum PaddleConsentRequirementType

PaddleCustomer:

• customers: object PaddleCustomer

PaddleCustomerToken:

• customers: object PaddleCustomerToken

PaddleDiscount:

• subscriptions: object PaddleDiscount

PaddleDiscountType:

• subscriptions: enum PaddleDiscountType

PaddleEntryID:

• api: type PaddleEntryID

PaddleItemStatus:

• api: enum PaddleItemStatus

PaddleItemType:

• api: enum PaddleItemType

PaddleManagementUrls:

• subscriptions: object PaddleManagementUrls

PaddlePaymentTerms:

• subscriptions: object PaddlePaymentTerms

PaddlePeriod:

• subscriptions: object PaddlePeriod

PaddlePrice:

• prices: object PaddlePrice

PaddleProduct:

• products: object PaddleProduct

PaddleScheduledChange:

• subscriptions: object PaddleScheduledChange

PaddleScheduledChangeAction:

• subscriptions: enum PaddleScheduledChangeAction

PaddleSubscription:

• subscriptions: object PaddleSubscription

PaddleSubscriptionItem:

• subscriptions: object PaddleSubscriptionItem

PaddleSubscriptionItemStatus:

• subscriptions: enum PaddleSubscriptionItemStatus

PaddleSubscriptionStatus:

• subscriptions: enum PaddleSubscriptionStatus

PaddleTaxCategory:

• api: enum PaddleTaxCategory

parseHook:

• api: proc parseHook(parser: var json.JsonParser; v: var DateTime)

past_due:

• subscriptions: PaddleSubscriptionStatus.past_due

patchCustomer:

• customers: proc patchCustomer(client: PaddleClient; id: PaddleEntryID; email: Option[string] = none(string); name: Option[string] = none(string); locale: Option[string] = none(string)): Future[ PaddleApiResponse[PaddleCustomer]]

pause:

• subscriptions: PaddleScheduledChangeAction.pause

paused:

• subscriptions: PaddleSubscriptionStatus.paused

pending:

• subscriptions: PaddleConsentRequirementStatus.pending

PLN:

• prices: CurrencyCode.PLN

postCustomer:

• customers: proc postCustomer(client: PaddleClient; email: string; name: string; locale: Option[string] = none(string)): Future[ PaddleApiResponse[PaddleCustomer]]

postPrice:

• prices: proc postPrice(client: PaddleClient; productId: PaddleEntryID; name: string; price: PriceUnit): Future[PaddleApiResponse[PaddlePrice]]
• prices: proc postPrice(client: PaddleClient; productId: PaddleEntryID; name: string; description: string; billingCycle: PaddleBillingCycle; unitPrice: PriceUnit; taxMode: PriceTaxMode = PriceTaxMode.taxModeAccountSetting; trialPeriod: Option[PaddleBillingCycle] = none(PaddleBillingCycle)): Future[ PaddleApiResponse[PaddlePrice]]

postProduct:

• products: proc postProduct(client: PaddleClient; name: string; taxCategory = PaddleTaxCategory.standard; description: Option[string] = none(string); imageUrl: Option[string] = none(string); customData: JsonNode = nil): Future[ PaddleApiResponse[PaddleProduct]]

PriceTaxMode:

• prices: enum PriceTaxMode

PriceUnit:

• prices: object PriceUnit

PriceUnitOverride:

• prices: object PriceUnitOverride

professionalServices:

• api: PaddleTaxCategory.professionalServices

QueryTable:

• api: type QueryTable

recurring:

• subscriptions: PaddleDiscountType.recurring

resume:

• subscriptions: PaddleScheduledChangeAction.resume

RUB:

• prices: CurrencyCode.RUB

saas:

• api: PaddleTaxCategory.saas

SEK:

• prices: CurrencyCode.SEK

SGD:

• prices: CurrencyCode.SGD

softwareProgrammingServices:

• api: PaddleTaxCategory.softwareProgrammingServices

standard:

• api: PaddleTaxCategory.standard
• api: PaddleItemType.standard

taxModeAccountSetting:

• prices: PriceTaxMode.taxModeAccountSetting

taxModeExternal:

• prices: PriceTaxMode.taxModeExternal

taxModeInternal:

• prices: PriceTaxMode.taxModeInternal

taxModeLocation:

• prices: PriceTaxMode.taxModeLocation

THB:

• prices: CurrencyCode.THB

trainingServices:

• api: PaddleTaxCategory.trainingServices

trialEnding:

• subscriptions: PaddleConsentRequirementType.trialEnding

trialing:

• subscriptions: PaddleSubscriptionStatus.trialing
• subscriptions: PaddleSubscriptionItemStatus.trialing

TRY:

• prices: CurrencyCode.TRY

TWD:

• prices: CurrencyCode.TWD

UAH:

• prices: CurrencyCode.UAH

USD:

• prices: CurrencyCode.USD

VND:

• prices: CurrencyCode.VND

voided:

• subscriptions: PaddleConsentRequirementStatus.voided

websiteHosting:

• api: PaddleTaxCategory.websiteHosting

week:

• prices: PaddleBillingInterval.week

year:

• prices: PaddleBillingInterval.year

ZAR:

• prices: CurrencyCode.ZAR