meteroid-rs 0.31.4

Official Rust SDK for Meteroid, the open-source billing platform: subscriptions, invoicing, usage-based billing and webhooks.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<!-- This file is @generated by perseid. Do not edit. -->
# Meteroid API

Every operation of the API, as a method of a `Meteroid` client (`client` below), by
resource. A `Call<T>` resolves to `Result<T>` when awaited, and to the status and headers too
with `.with_response()`; `with_options(RequestOptions)` on a resource sets the headers, timeout,
retries or idempotency key of its calls. A paginated list returns a `PageCall<Body, Item>`:
awaited, a `Page` that dereferences to the body (`page.field`) and lists `page.items()`, with
`next_page()`; `.items()` streams every item across pages and `.pages()` every page. Models are
in [`src/models`](src/models), and the options structs next to their resource.

[Add ons](#add-ons) · [Add ons entitlements](#add-ons-entitlements) · [Batch jobs](#batch-jobs) · [Budgets](#budgets) · [Checkout sessions](#checkout-sessions) · [Checks](#checks) · [Connect](#connect) · [Coupons](#coupons) · [Credit notes](#credit-notes) · [Credit units](#credit-units) · [Credit units prices](#credit-units-prices) · [Credits](#credits) · [Credits grants](#credits-grants) · [Credits wallets](#credits-wallets) · [Custom properties](#custom-properties) · [Customers](#customers) · [Entitlements](#entitlements) · [Events](#events) · [Features](#features) · [Invoices](#invoices) · [Licenses](#licenses) · [Metrics](#metrics) · [Oauth](#oauth) · [Oauth apps](#oauth-apps) · [Plans](#plans) · [Plans versions](#plans-versions) · [Product families](#product-families) · [Products](#products) · [Products entitlements](#products-entitlements) · [Subscriptions](#subscriptions) · [Usage](#usage) · [Usage customer](#usage-customer) · [Usage costs](#usage-costs) · [Usage costs customer](#usage-costs-customer) · [Usage costs subscription](#usage-costs-subscription) · [Webhook endpoints](#webhook-endpoints) · [Webhook endpoints endpoints](#webhook-endpoints-endpoints)

## Add ons

[`client.add_ons()`](src/api/add_ons.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.add_ons().list(options: impl Into<Option<AddOnsListOptions>>) -> PageCall<AddOnListResponse, AddOn>` | `GET /api/v1/addons` | [`AddOnListResponse`](src/models/add_on_list_response.rs) page of [`AddOn`](src/models/add_on.rs) |
| `client.add_ons().create(create_add_on_request: CreateAddOnRequest) -> Call<AddOn>` | `POST /api/v1/addons` | [`AddOn`](src/models/add_on.rs) |
| `client.add_ons().retrieve(addon_id: &str) -> Call<AddOn>` | `GET /api/v1/addons/{addon_id}` | [`AddOn`](src/models/add_on.rs) |
| `client.add_ons().update(addon_id: &str, update_add_on_request: UpdateAddOnRequest) -> Call<AddOn>` | `PATCH /api/v1/addons/{addon_id}` | [`AddOn`](src/models/add_on.rs) |
| `client.add_ons().archive(addon_id: &str) -> Call<()>` | `POST /api/v1/addons/{addon_id}/archive` | nothing |
| `client.add_ons().unarchive(addon_id: &str) -> Call<()>` | `POST /api/v1/addons/{addon_id}/unarchive` | nothing |

### Add ons entitlements

[`client.add_ons().entitlements()`](src/api/add_ons_entitlements.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.add_ons().entitlements().list(addon_id: &str) -> Call<ResolvedEntitlementListResponse>` | `GET /api/v1/addons/{addon_id}/entitlements` | [`ResolvedEntitlementListResponse`](src/models/resolved_entitlement_list_response.rs) |
| `client.add_ons().entitlements().create(addon_id: &str, create_entitlements_request: CreateEntitlementsRequest) -> Call<EntitlementListResponse>` | `POST /api/v1/addons/{addon_id}/entitlements` | [`EntitlementListResponse`](src/models/entitlement_list_response.rs) |

## Batch jobs

[`client.batch_jobs()`](src/api/batch_jobs.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.batch_jobs().list(options: impl Into<Option<BatchJobsListOptions>>) -> PageCall<BatchJobListResponse, BatchJobResponse>` | `GET /api/v1/batch-jobs` | [`BatchJobListResponse`](src/models/batch_job_list_response.rs) page of [`BatchJobResponse`](src/models/batch_job_response.rs) |
| `client.batch_jobs().retrieve(batch_job_id: &str) -> Call<BatchJobDetailResponse>` | `GET /api/v1/batch-jobs/{batch_job_id}` | [`BatchJobDetailResponse`](src/models/batch_job_detail_response.rs) |
| `client.batch_jobs().list_failures(batch_job_id: &str, options: impl Into<Option<BatchJobsListFailuresOptions>>) -> PageCall<BatchJobFailuresResponse, BatchJobItemFailureResponse>` | `GET /api/v1/batch-jobs/{batch_job_id}/failures` | [`BatchJobFailuresResponse`](src/models/batch_job_failures_response.rs) page of [`BatchJobItemFailureResponse`](src/models/batch_job_item_failure_response.rs) |

## Budgets

[`client.budgets()`](src/api/budgets.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.budgets().list(id_or_alias: &str, options: impl Into<Option<BudgetsListOptions>>) -> PageCall<BudgetListResponse, Budget>` | `GET /api/v1/customers/{id_or_alias}/budgets` | [`BudgetListResponse`](src/models/budget_list_response.rs) page of [`Budget`](src/models/budget.rs) |
| `client.budgets().create(id_or_alias: &str, create_budget_request: CreateBudgetRequest, options: BudgetsCreateOptions) -> Call<Budget>` | `POST /api/v1/customers/{id_or_alias}/budgets` | [`Budget`](src/models/budget.rs) |
| `client.budgets().update(id_or_alias: &str, budget_id: &str, patch_budget_request: PatchBudgetRequest, options: BudgetsUpdateOptions) -> Call<Budget>` | `PATCH /api/v1/customers/{id_or_alias}/budgets/{budget_id}` | [`Budget`](src/models/budget.rs) |
| `client.budgets().archive(id_or_alias: &str, budget_id: &str, options: BudgetsArchiveOptions) -> Call<Budget>` | `POST /api/v1/customers/{id_or_alias}/budgets/{budget_id}/archive` | [`Budget`](src/models/budget.rs) |

## Checkout sessions

[`client.checkout_sessions()`](src/api/checkout_sessions.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.checkout_sessions().list(options: impl Into<Option<CheckoutSessionsListOptions>>) -> Call<ListCheckoutSessionsResponse>` | `GET /api/v1/checkout-sessions` | [`ListCheckoutSessionsResponse`](src/models/list_checkout_sessions_response.rs) |
| `client.checkout_sessions().create(create_checkout_session_request: CreateCheckoutSessionRequest) -> Call<CreateCheckoutSessionResponse>` | `POST /api/v1/checkout-sessions` | [`CreateCheckoutSessionResponse`](src/models/create_checkout_session_response.rs) |
| `client.checkout_sessions().retrieve(id: &str) -> Call<GetCheckoutSessionResponse>` | `GET /api/v1/checkout-sessions/{id}` | [`GetCheckoutSessionResponse`](src/models/get_checkout_session_response.rs) |
| `client.checkout_sessions().cancel(id: &str) -> Call<CancelCheckoutSessionResponse>` | `POST /api/v1/checkout-sessions/{id}/cancel` | [`CancelCheckoutSessionResponse`](src/models/cancel_checkout_session_response.rs) |

## Checks

[`client.checks()`](src/api/checks.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.checks().check_entitlement(id_or_alias: &str, feature_id_or_code: &str, options: impl Into<Option<ChecksCheckEntitlementOptions>>) -> Call<EntitlementCheck>` | `GET /api/v1/customers/{id_or_alias}/entitlements/{feature_id_or_code}/check` | [`EntitlementCheck`](src/models/entitlement_check.rs) |

## Connect

[`client.connect()`](src/api/connect.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.connect().list_connected_accounts() -> Call<ConnectedAccountsResponse>` | `GET /api/v1/connected-accounts` | [`ConnectedAccountsResponse`](src/models/connected_accounts_response.rs) |
| `client.connect().create_connected_account(create_connected_account_request: CreateConnectedAccountRequest) -> Call<CreateConnectedAccountResponse>` | `POST /api/v1/connected-accounts` | [`CreateConnectedAccountResponse`](src/models/create_connected_account_response.rs) |
| `client.connect().retrieve_connected_account(id: &str) -> Call<ConnectedAccount>` | `GET /api/v1/connected-accounts/{id}` | [`ConnectedAccount`](src/models/connected_account.rs) |
| `client.connect().disconnect_account(id: &str) -> Call<()>` | `DELETE /api/v1/connected-accounts/{id}` | nothing |
| `client.connect().create_onboarding_link(id: &str, create_onboarding_link_request: CreateOnboardingLinkRequest) -> Call<OnboardingLinkResponse>` | `POST /api/v1/connected-accounts/{id}/onboarding` | [`OnboardingLinkResponse`](src/models/onboarding_link_response.rs) |

## Coupons

[`client.coupons()`](src/api/coupons.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.coupons().list(options: impl Into<Option<CouponsListOptions>>) -> PageCall<CouponListResponse, Coupon>` | `GET /api/v1/coupons` | [`CouponListResponse`](src/models/coupon_list_response.rs) page of [`Coupon`](src/models/coupon.rs) |
| `client.coupons().create(create_coupon_request: CreateCouponRequest) -> Call<Coupon>` | `POST /api/v1/coupons` | [`Coupon`](src/models/coupon.rs) |
| `client.coupons().retrieve(coupon_id: &str) -> Call<Coupon>` | `GET /api/v1/coupons/{coupon_id}` | [`Coupon`](src/models/coupon.rs) |
| `client.coupons().update(coupon_id: &str, update_coupon_request: UpdateCouponRequest) -> Call<Coupon>` | `PATCH /api/v1/coupons/{coupon_id}` | [`Coupon`](src/models/coupon.rs) |
| `client.coupons().archive(coupon_id: &str) -> Call<()>` | `POST /api/v1/coupons/{coupon_id}/archive` | nothing |
| `client.coupons().disable(coupon_id: &str) -> Call<()>` | `POST /api/v1/coupons/{coupon_id}/disable` | nothing |
| `client.coupons().enable(coupon_id: &str) -> Call<()>` | `POST /api/v1/coupons/{coupon_id}/enable` | nothing |
| `client.coupons().unarchive(coupon_id: &str) -> Call<()>` | `POST /api/v1/coupons/{coupon_id}/unarchive` | nothing |

## Credit notes

[`client.credit_notes()`](src/api/credit_notes.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credit_notes().list(options: impl Into<Option<CreditNotesListOptions>>) -> PageCall<CreditNoteListResponse, CreditNote>` | `GET /api/v1/credit-notes` | [`CreditNoteListResponse`](src/models/credit_note_list_response.rs) page of [`CreditNote`](src/models/credit_note.rs) |
| `client.credit_notes().retrieve(credit_note_id: &str) -> Call<CreditNote>` | `GET /api/v1/credit-notes/{credit_note_id}` | [`CreditNote`](src/models/credit_note.rs) |
| `client.credit_notes().update_custom_properties(credit_note_id: &str, credit_note_custom_properties_request: CreditNoteCustomPropertiesRequest) -> Call<CreditNote>` | `PATCH /api/v1/credit-notes/{credit_note_id}/custom-properties` | [`CreditNote`](src/models/credit_note.rs) |
| `client.credit_notes().download(credit_note_id: &str) -> Call<Bytes>` | `GET /api/v1/credit-notes/{credit_note_id}/download` | bytes |
| `client.credit_notes().download_xml(credit_note_id: &str) -> Call<Bytes>` | `GET /api/v1/credit-notes/{credit_note_id}/xml` | bytes |

## Credit units

[`client.credit_units()`](src/api/credit_units.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credit_units().list(options: impl Into<Option<CreditUnitsListOptions>>) -> Call<CreditUnitListResponse>` | `GET /api/v1/credit-units` | [`CreditUnitListResponse`](src/models/credit_unit_list_response.rs) |
| `client.credit_units().create(credit_unit_create_request: CreditUnitCreateRequest) -> Call<CreditUnit>` | `POST /api/v1/credit-units` | [`CreditUnit`](src/models/credit_unit.rs) |
| `client.credit_units().retrieve(id: &str) -> Call<CreditUnit>` | `GET /api/v1/credit-units/{id}` | [`CreditUnit`](src/models/credit_unit.rs) |
| `client.credit_units().update(id: &str, credit_unit_update_request: CreditUnitUpdateRequest) -> Call<CreditUnit>` | `PATCH /api/v1/credit-units/{id}` | [`CreditUnit`](src/models/credit_unit.rs) |

### Credit units prices

[`client.credit_units().prices()`](src/api/credit_units_prices.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credit_units().prices().list(id: &str, options: impl Into<Option<CreditUnitsPricesListOptions>>) -> Call<CreditUnitPriceListResponse>` | `GET /api/v1/credit-units/{id}/prices` | [`CreditUnitPriceListResponse`](src/models/credit_unit_price_list_response.rs) |
| `client.credit_units().prices().update(id: &str, currency: &str, credit_unit_price_set_request: CreditUnitPriceSetRequest) -> Call<CreditUnitPrice>` | `PUT /api/v1/credit-units/{id}/prices/{currency}` | [`CreditUnitPrice`](src/models/credit_unit_price.rs) |
| `client.credit_units().prices().archive(id: &str, currency: &str) -> Call<CreditUnitPrice>` | `DELETE /api/v1/credit-units/{id}/prices/{currency}` | [`CreditUnitPrice`](src/models/credit_unit_price.rs) |

## Credits

[`client.credits()`](src/api/credits.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credits().list_customer_credit_ledger(id_or_alias: &str, options: impl Into<Option<CreditsListCustomerCreditLedgerOptions>>) -> PageCall<LedgerListResponse, LedgerEntry>` | `GET /api/v1/customers/{id_or_alias}/credit-ledger` | [`LedgerListResponse`](src/models/ledger_list_response.rs) page of [`LedgerEntry`](src/models/ledger_entry.rs) |
| `client.credits().create_customer_top_up(id_or_alias: &str, create_top_up_request: CreateTopUpRequest, options: CreditsCreateCustomerTopUpOptions) -> Call<TopUpResponse>` | `POST /api/v1/customers/{id_or_alias}/top-ups` | [`TopUpResponse`](src/models/top_up_response.rs) |

### Credits grants

[`client.credits().grants()`](src/api/credits_grants.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credits().grants().list(id_or_alias: &str, options: impl Into<Option<CreditsGrantsListOptions>>) -> PageCall<CreditGrantListResponse, CreditGrant>` | `GET /api/v1/customers/{id_or_alias}/credit-grants` | [`CreditGrantListResponse`](src/models/credit_grant_list_response.rs) page of [`CreditGrant`](src/models/credit_grant.rs) |
| `client.credits().grants().create(id_or_alias: &str, create_credit_grant_request: CreateCreditGrantRequest, options: CreditsGrantsCreateOptions) -> Call<CreditGrant>` | `POST /api/v1/customers/{id_or_alias}/credit-grants` | [`CreditGrant`](src/models/credit_grant.rs) |

### Credits wallets

[`client.credits().wallets()`](src/api/credits_wallets.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.credits().wallets().list(id_or_alias: &str, options: impl Into<Option<CreditsWalletsListOptions>>) -> Call<WalletListResponse>` | `GET /api/v1/customers/{id_or_alias}/wallets` | [`WalletListResponse`](src/models/wallet_list_response.rs) |
| `client.credits().wallets().check(id_or_alias: &str, options: impl Into<Option<CreditsWalletsCheckOptions>>) -> Call<WalletCheck>` | `GET /api/v1/customers/{id_or_alias}/wallets/check` | [`WalletCheck`](src/models/wallet_check.rs) |
| `client.credits().wallets().update(id_or_alias: &str, currency: &str, patch_wallet_request: PatchWalletRequest, options: CreditsWalletsUpdateOptions) -> Call<Wallet>` | `PATCH /api/v1/customers/{id_or_alias}/wallets/{currency}` | [`Wallet`](src/models/wallet.rs) |

## Custom properties

[`client.custom_properties()`](src/api/custom_properties.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.custom_properties().list_custom_property_definitions(options: impl Into<Option<CustomPropertiesListCustomPropertyDefinitionsOptions>>) -> PageCall<CustomPropertyDefinitionListResponse, CustomPropertyDefinition>` | `GET /api/v1/custom-property-definitions` | [`CustomPropertyDefinitionListResponse`](src/models/custom_property_definition_list_response.rs) page of [`CustomPropertyDefinition`](src/models/custom_property_definition.rs) |
| `client.custom_properties().create_custom_property_definition(custom_property_definition_create_request: CustomPropertyDefinitionCreateRequest) -> Call<CustomPropertyDefinition>` | `POST /api/v1/custom-property-definitions` | [`CustomPropertyDefinition`](src/models/custom_property_definition.rs) |
| `client.custom_properties().retrieve_custom_property_definition(id: &str) -> Call<CustomPropertyDefinition>` | `GET /api/v1/custom-property-definitions/{id}` | [`CustomPropertyDefinition`](src/models/custom_property_definition.rs) |
| `client.custom_properties().update_custom_property_definition(id: &str, custom_property_definition_update_request: CustomPropertyDefinitionUpdateRequest) -> Call<CustomPropertyDefinition>` | `PUT /api/v1/custom-property-definitions/{id}` | [`CustomPropertyDefinition`](src/models/custom_property_definition.rs) |
| `client.custom_properties().archive_definition(id: &str) -> Call<CustomPropertyDefinition>` | `DELETE /api/v1/custom-property-definitions/{id}` | [`CustomPropertyDefinition`](src/models/custom_property_definition.rs) |

## Customers

[`client.customers()`](src/api/customers.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.customers().list(options: impl Into<Option<CustomersListOptions>>) -> PageCall<CustomerListResponse, Customer>` | `GET /api/v1/customers` | [`CustomerListResponse`](src/models/customer_list_response.rs) page of [`Customer`](src/models/customer.rs) |
| `client.customers().create(customer_create_request: CustomerCreateRequest) -> Call<Customer>` | `POST /api/v1/customers` | [`Customer`](src/models/customer.rs) |
| `client.customers().retrieve(id_or_alias: &str) -> Call<Customer>` | `GET /api/v1/customers/{id_or_alias}` | [`Customer`](src/models/customer.rs) |
| `client.customers().replace(id_or_alias: &str, customer_update_request: CustomerUpdateRequest) -> Call<Customer>` | `PUT /api/v1/customers/{id_or_alias}` | [`Customer`](src/models/customer.rs) |
| `client.customers().archive(id_or_alias: &str) -> Call<()>` | `DELETE /api/v1/customers/{id_or_alias}` | nothing |
| `client.customers().update(id_or_alias: &str, customer_patch_request: CustomerPatchRequest) -> Call<Customer>` | `PATCH /api/v1/customers/{id_or_alias}` | [`Customer`](src/models/customer.rs) |
| `client.customers().list_entitlements(id_or_alias: &str) -> Call<EffectiveEntitlementListResponse>` | `GET /api/v1/customers/{id_or_alias}/entitlements` | [`EffectiveEntitlementListResponse`](src/models/effective_entitlement_list_response.rs) |
| `client.customers().create_portal_token(id_or_alias: &str, customer_portal_token_request: CustomerPortalTokenRequest) -> Call<CustomerPortalTokenResponse>` | `POST /api/v1/customers/{id_or_alias}/portal-token` | [`CustomerPortalTokenResponse`](src/models/customer_portal_token_response.rs) |
| `client.customers().unarchive(id_or_alias: &str) -> Call<()>` | `POST /api/v1/customers/{id_or_alias}/unarchive` | nothing |

## Entitlements

[`client.entitlements()`](src/api/entitlements.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.entitlements().retrieve(entitlement_id: &str) -> Call<Entitlement>` | `GET /api/v1/entitlements/{entitlement_id}` | [`Entitlement`](src/models/entitlement.rs) |
| `client.entitlements().delete(entitlement_id: &str) -> Call<()>` | `DELETE /api/v1/entitlements/{entitlement_id}` | nothing |
| `client.entitlements().update(entitlement_id: &str, update_entitlement_request: UpdateEntitlementRequest) -> Call<Entitlement>` | `PATCH /api/v1/entitlements/{entitlement_id}` | [`Entitlement`](src/models/entitlement.rs) |

## Events

[`client.events()`](src/api/events.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.events().ingest(ingest_events_request: IngestEventsRequest) -> Call<IngestEventsResponse>` | `POST /api/v1/events/ingest` | [`IngestEventsResponse`](src/models/ingest_events_response.rs) |

## Features

[`client.features()`](src/api/features.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.features().list(options: impl Into<Option<FeaturesListOptions>>) -> PageCall<FeatureListResponse, Feature>` | `GET /api/v1/features` | [`FeatureListResponse`](src/models/feature_list_response.rs) page of [`Feature`](src/models/feature.rs) |
| `client.features().create(create_feature_request: CreateFeatureRequest) -> Call<Feature>` | `POST /api/v1/features` | [`Feature`](src/models/feature.rs) |
| `client.features().retrieve(id_or_code: &str) -> Call<Feature>` | `GET /api/v1/features/{id_or_code}` | [`Feature`](src/models/feature.rs) |
| `client.features().update(id_or_code: &str, update_feature_request: UpdateFeatureRequest) -> Call<Feature>` | `PATCH /api/v1/features/{id_or_code}` | [`Feature`](src/models/feature.rs) |
| `client.features().archive(id_or_code: &str) -> Call<()>` | `POST /api/v1/features/{id_or_code}/archive` | nothing |
| `client.features().unarchive(id_or_code: &str) -> Call<()>` | `POST /api/v1/features/{id_or_code}/unarchive` | nothing |

## Invoices

[`client.invoices()`](src/api/invoices.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.invoices().list(options: impl Into<Option<InvoicesListOptions>>) -> PageCall<InvoiceListResponse, Invoice>` | `GET /api/v1/invoices` | [`InvoiceListResponse`](src/models/invoice_list_response.rs) page of [`Invoice`](src/models/invoice.rs) |
| `client.invoices().retrieve(invoice_id: &str) -> Call<Invoice>` | `GET /api/v1/invoices/{invoice_id}` | [`Invoice`](src/models/invoice.rs) |
| `client.invoices().update_custom_properties(invoice_id: &str, invoice_custom_properties_request: InvoiceCustomPropertiesRequest) -> Call<Invoice>` | `PATCH /api/v1/invoices/{invoice_id}/custom-properties` | [`Invoice`](src/models/invoice.rs) |
| `client.invoices().download(invoice_id: &str) -> Call<Bytes>` | `GET /api/v1/invoices/{invoice_id}/download` | bytes |
| `client.invoices().refresh(invoice_id: &str) -> Call<Invoice>` | `POST /api/v1/invoices/{invoice_id}/refresh` | [`Invoice`](src/models/invoice.rs) |
| `client.invoices().download_xml(invoice_id: &str) -> Call<Bytes>` | `GET /api/v1/invoices/{invoice_id}/xml` | bytes |

## Licenses

[`client.licenses()`](src/api/licenses.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.licenses().list(options: impl Into<Option<LicensesListOptions>>) -> Call<LicenseListResponse>` | `GET /api/v1/licenses` | [`LicenseListResponse`](src/models/license_list_response.rs) |
| `client.licenses().create(issue_license_request: IssueLicenseRequest) -> Call<IssueLicenseResponse>` | `POST /api/v1/licenses` | [`IssueLicenseResponse`](src/models/issue_license_response.rs) |
| `client.licenses().retrieve(license_id: &str) -> Call<License>` | `GET /api/v1/licenses/{license_id}` | [`License`](src/models/license.rs) |
| `client.licenses().retrieve_activation_code(license_id: &str) -> Call<LicenseActivationCode>` | `GET /api/v1/licenses/{license_id}/activation-code` | [`LicenseActivationCode`](src/models/license_activation_code.rs) |
| `client.licenses().offline(license_id: &str, issue_offline_license_request: IssueOfflineLicenseRequest) -> Call<OfflineLicense>` | `POST /api/v1/licenses/{license_id}/offline` | [`OfflineLicense`](src/models/offline_license.rs) |
| `client.licenses().revoke(license_id: &str, revoke_license_request: RevokeLicenseRequest) -> Call<License>` | `POST /api/v1/licenses/{license_id}/revoke` | [`License`](src/models/license.rs) |
| `client.licenses().list_licensing_signing_keys() -> Call<LicenseSigningKeysResponse>` | `GET /api/v1/licensing/signing-keys` | [`LicenseSigningKeysResponse`](src/models/license_signing_keys_response.rs) |

## Metrics

[`client.metrics()`](src/api/metrics.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.metrics().list(options: impl Into<Option<MetricsListOptions>>) -> PageCall<MetricListResponse, MetricSummary>` | `GET /api/v1/metrics` | [`MetricListResponse`](src/models/metric_list_response.rs) page of [`MetricSummary`](src/models/metric_summary.rs) |
| `client.metrics().create(create_metric_request: CreateMetricRequest) -> Call<Metric>` | `POST /api/v1/metrics` | [`Metric`](src/models/metric.rs) |
| `client.metrics().retrieve(metric_id: &str) -> Call<Metric>` | `GET /api/v1/metrics/{metric_id}` | [`Metric`](src/models/metric.rs) |
| `client.metrics().update(metric_id: &str, update_metric_request: UpdateMetricRequest) -> Call<Metric>` | `PATCH /api/v1/metrics/{metric_id}` | [`Metric`](src/models/metric.rs) |
| `client.metrics().archive(metric_id: &str) -> Call<()>` | `POST /api/v1/metrics/{metric_id}/archive` | nothing |
| `client.metrics().unarchive(metric_id: &str) -> Call<()>` | `POST /api/v1/metrics/{metric_id}/unarchive` | nothing |

## Oauth

[`client.oauth()`](src/api/oauth.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.oauth().introspect(introspection_request: IntrospectionRequest) -> Call<TokenIntrospectionResponse>` | `POST /api/v1/oauth/introspect` | [`TokenIntrospectionResponse`](src/models/token_introspection_response.rs) |
| `client.oauth().revoke(revocation_request: RevocationRequest) -> Call<()>` | `POST /api/v1/oauth/revoke` | nothing |
| `client.oauth().token(token_request: TokenRequest) -> Call<TokenResponse>` | `POST /api/v1/oauth/token` | [`TokenResponse`](src/models/token_response.rs) |

## Oauth apps

[`client.oauth_apps()`](src/api/oauth_apps.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.oauth_apps().list() -> Call<OAuthAppsResponse>` | `GET /api/v1/oauth-apps` | [`OAuthAppsResponse`](src/models/o_auth_apps_response.rs) |
| `client.oauth_apps().create(create_o_auth_app_request: CreateOAuthAppRequest) -> Call<OAuthAppWithSecret>` | `POST /api/v1/oauth-apps` | [`OAuthAppWithSecret`](src/models/o_auth_app_with_secret.rs) |
| `client.oauth_apps().retrieve(id: &str) -> Call<OAuthApp>` | `GET /api/v1/oauth-apps/{id}` | [`OAuthApp`](src/models/o_auth_app.rs) |
| `client.oauth_apps().delete(id: &str) -> Call<()>` | `DELETE /api/v1/oauth-apps/{id}` | nothing |
| `client.oauth_apps().rotate(id: &str) -> Call<RotatedSecret>` | `POST /api/v1/oauth-apps/{id}/rotate` | [`RotatedSecret`](src/models/rotated_secret.rs) |

## Plans

[`client.plans()`](src/api/plans.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.plans().list_plan_version_entitlements(plan_version_id: &str) -> Call<ResolvedEntitlementListResponse>` | `GET /api/v1/plan-versions/{plan_version_id}/entitlements` | [`ResolvedEntitlementListResponse`](src/models/resolved_entitlement_list_response.rs) |
| `client.plans().create_plan_version_entitlement(plan_version_id: &str, create_entitlements_request: CreateEntitlementsRequest) -> Call<EntitlementListResponse>` | `POST /api/v1/plan-versions/{plan_version_id}/entitlements` | [`EntitlementListResponse`](src/models/entitlement_list_response.rs) |
| `client.plans().list(options: impl Into<Option<PlansListOptions>>) -> PageCall<PlanListResponse, Plan>` | `GET /api/v1/plans` | [`PlanListResponse`](src/models/plan_list_response.rs) page of [`Plan`](src/models/plan.rs) |
| `client.plans().create(create_plan_request: CreatePlanRequest) -> Call<Plan>` | `POST /api/v1/plans` | [`Plan`](src/models/plan.rs) |
| `client.plans().retrieve(plan_id: &str, options: impl Into<Option<PlansRetrieveOptions>>) -> Call<Plan>` | `GET /api/v1/plans/{plan_id}` | [`Plan`](src/models/plan.rs) |
| `client.plans().replace(plan_id: &str, replace_plan_request: ReplacePlanRequest) -> Call<Plan>` | `PUT /api/v1/plans/{plan_id}` | [`Plan`](src/models/plan.rs) |
| `client.plans().update(plan_id: &str, patch_plan_request: PatchPlanRequest) -> Call<Plan>` | `PATCH /api/v1/plans/{plan_id}` | [`Plan`](src/models/plan.rs) |
| `client.plans().archive(plan_id: &str) -> Call<()>` | `POST /api/v1/plans/{plan_id}/archive` | nothing |
| `client.plans().publish(plan_id: &str) -> Call<Plan>` | `POST /api/v1/plans/{plan_id}/publish` | [`Plan`](src/models/plan.rs) |
| `client.plans().unarchive(plan_id: &str) -> Call<()>` | `POST /api/v1/plans/{plan_id}/unarchive` | nothing |

### Plans versions

[`client.plans().versions()`](src/api/plans_versions.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.plans().versions().update_minimum(plan_version_id: &str, minimum_commitment: MinimumCommitment) -> Call<MinimumCommitment>` | `PUT /api/v1/plans/versions/{plan_version_id}/minimum` | [`MinimumCommitment`](src/models/minimum_commitment.rs) |
| `client.plans().versions().delete_minimum(plan_version_id: &str) -> Call<()>` | `DELETE /api/v1/plans/versions/{plan_version_id}/minimum` | nothing |
| `client.plans().versions().list(plan_id: &str, options: impl Into<Option<PlansVersionsListOptions>>) -> PageCall<PlanVersionListResponse, PlanVersionSummary>` | `GET /api/v1/plans/{plan_id}/versions` | [`PlanVersionListResponse`](src/models/plan_version_list_response.rs) page of [`PlanVersionSummary`](src/models/plan_version_summary.rs) |

## Product families

[`client.product_families()`](src/api/product_families.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.product_families().list(options: impl Into<Option<ProductFamiliesListOptions>>) -> PageCall<ProductFamilyListResponse, ProductFamily>` | `GET /api/v1/product_families` | [`ProductFamilyListResponse`](src/models/product_family_list_response.rs) page of [`ProductFamily`](src/models/product_family.rs) |
| `client.product_families().create(product_family_create_request: ProductFamilyCreateRequest) -> Call<ProductFamily>` | `POST /api/v1/product_families` | [`ProductFamily`](src/models/product_family.rs) |
| `client.product_families().retrieve(id_or_alias: &str) -> Call<ProductFamily>` | `GET /api/v1/product_families/{id_or_alias}` | [`ProductFamily`](src/models/product_family.rs) |

## Products

[`client.products()`](src/api/products.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.products().list(options: impl Into<Option<ProductsListOptions>>) -> PageCall<ProductListResponse, Product>` | `GET /api/v1/products` | [`ProductListResponse`](src/models/product_list_response.rs) page of [`Product`](src/models/product.rs) |
| `client.products().create(create_product_request: CreateProductRequest) -> Call<Product>` | `POST /api/v1/products` | [`Product`](src/models/product.rs) |
| `client.products().retrieve(product_id: &str) -> Call<Product>` | `GET /api/v1/products/{product_id}` | [`Product`](src/models/product.rs) |
| `client.products().update(product_id: &str, update_product_request: UpdateProductRequest) -> Call<Product>` | `PATCH /api/v1/products/{product_id}` | [`Product`](src/models/product.rs) |
| `client.products().archive(product_id: &str) -> Call<()>` | `POST /api/v1/products/{product_id}/archive` | nothing |
| `client.products().unarchive(product_id: &str) -> Call<()>` | `POST /api/v1/products/{product_id}/unarchive` | nothing |

### Products entitlements

[`client.products().entitlements()`](src/api/products_entitlements.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.products().entitlements().list(product_id: &str) -> Call<ResolvedEntitlementListResponse>` | `GET /api/v1/products/{product_id}/entitlements` | [`ResolvedEntitlementListResponse`](src/models/resolved_entitlement_list_response.rs) |
| `client.products().entitlements().create(product_id: &str, create_entitlements_request: CreateEntitlementsRequest) -> Call<EntitlementListResponse>` | `POST /api/v1/products/{product_id}/entitlements` | [`EntitlementListResponse`](src/models/entitlement_list_response.rs) |

## Subscriptions

[`client.subscriptions()`](src/api/subscriptions.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.subscriptions().list(options: impl Into<Option<SubscriptionsListOptions>>) -> PageCall<SubscriptionListResponse, Subscription>` | `GET /api/v1/subscriptions` | [`SubscriptionListResponse`](src/models/subscription_list_response.rs) page of [`Subscription`](src/models/subscription.rs) |
| `client.subscriptions().create(subscription_create_request: SubscriptionCreateRequest) -> Call<SubscriptionDetails>` | `POST /api/v1/subscriptions` | [`SubscriptionDetails`](src/models/subscription_details.rs) |
| `client.subscriptions().retrieve(subscription_id: &str) -> Call<SubscriptionDetails>` | `GET /api/v1/subscriptions/{subscription_id}` | [`SubscriptionDetails`](src/models/subscription_details.rs) |
| `client.subscriptions().update(subscription_id: &str, subscription_update_request: SubscriptionUpdateRequest) -> Call<SubscriptionUpdateResponse>` | `PATCH /api/v1/subscriptions/{subscription_id}` | [`SubscriptionUpdateResponse`](src/models/subscription_update_response.rs) |
| `client.subscriptions().cancel(subscription_id: &str, cancel_subscription_request: CancelSubscriptionRequest) -> Call<CancelSubscriptionResponse>` | `POST /api/v1/subscriptions/{subscription_id}/cancel` | [`CancelSubscriptionResponse`](src/models/cancel_subscription_response.rs) |
| `client.subscriptions().list_entitlements(subscription_id: &str) -> Call<EffectiveEntitlementListResponse>` | `GET /api/v1/subscriptions/{subscription_id}/entitlements` | [`EffectiveEntitlementListResponse`](src/models/effective_entitlement_list_response.rs) |
| `client.subscriptions().retrieve_summary(subscription_id: &str) -> Call<Subscription>` | `GET /api/v1/subscriptions/{subscription_id}/summary` | [`Subscription`](src/models/subscription.rs) |

## Usage

[`client.usage()`](src/api/usage.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.usage().retrieve_subscription(subscription_id: &str, options: impl Into<Option<UsageRetrieveSubscriptionOptions>>) -> Call<UsageResponse>` | `GET /api/v1/usage/subscription/{subscription_id}` | [`UsageResponse`](src/models/usage_response.rs) |
| `client.usage().retrieve_summary(options: UsageRetrieveSummaryOptions) -> Call<UsageResponse>` | `GET /api/v1/usage/summary` | [`UsageResponse`](src/models/usage_response.rs) |

### Usage customer

[`client.usage().customer()`](src/api/usage_customer.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.usage().customer().retrieve(customer_id: &str, options: UsageCustomerRetrieveOptions) -> Call<UsageResponse>` | `GET /api/v1/usage/customer/{customer_id}` | [`UsageResponse`](src/models/usage_response.rs) |
| `client.usage().customer().retrieve_unattributed(customer_id: &str, options: impl Into<Option<UsageCustomerRetrieveUnattributedOptions>>) -> Call<UnattributedUsageResponse>` | `GET /api/v1/usage/customer/{customer_id}/unattributed` | [`UnattributedUsageResponse`](src/models/unattributed_usage_response.rs) |

## Usage costs

[`client.usage_costs()`](src/api/usage_costs.rs)

| Method | Request | Returns |
| --- | --- | --- |

### Usage costs customer

[`client.usage_costs().customer()`](src/api/usage_costs_customer.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.usage_costs().customer().list_costs(customer_id: &str, options: UsageCostsCustomerListCostsOptions) -> Call<UsageCostListResponse>` | `GET /api/v1/usage/customer/{customer_id}/costs` | [`UsageCostListResponse`](src/models/usage_cost_list_response.rs) |
| `client.usage_costs().customer().list_events(customer_id: &str, options: UsageCostsCustomerListEventsOptions) -> Call<UsageEventListResponse>` | `GET /api/v1/usage/customer/{customer_id}/events` | [`UsageEventListResponse`](src/models/usage_event_list_response.rs) |

### Usage costs subscription

[`client.usage_costs().subscription()`](src/api/usage_costs_subscription.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.usage_costs().subscription().list_costs(subscription_id: &str, options: UsageCostsSubscriptionListCostsOptions) -> Call<UsageCostListResponse>` | `GET /api/v1/usage/subscription/{subscription_id}/costs` | [`UsageCostListResponse`](src/models/usage_cost_list_response.rs) |
| `client.usage_costs().subscription().list_events(subscription_id: &str, options: UsageCostsSubscriptionListEventsOptions) -> Call<UsageEventListResponse>` | `GET /api/v1/usage/subscription/{subscription_id}/events` | [`UsageEventListResponse`](src/models/usage_event_list_response.rs) |

## Webhook endpoints

[`client.webhook_endpoints()`](src/api/webhook_endpoints.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.webhook_endpoints().resend_webhook_delivery(delivery_id: &str) -> Call<WebhookDelivery>` | `POST /api/v1/webhooks/deliveries/{delivery_id}/resend` | [`WebhookDelivery`](src/models/webhook_delivery.rs) |

### Webhook endpoints endpoints

[`client.webhook_endpoints().endpoints()`](src/api/webhook_endpoints_endpoints.rs)

| Method | Request | Returns |
| --- | --- | --- |
| `client.webhook_endpoints().endpoints().list() -> Call<WebhookEndpointListResponse>` | `GET /api/v1/webhooks/endpoints` | [`WebhookEndpointListResponse`](src/models/webhook_endpoint_list_response.rs) |
| `client.webhook_endpoints().endpoints().create(create_webhook_endpoint_request: CreateWebhookEndpointRequest) -> Call<CreatedWebhookEndpoint>` | `POST /api/v1/webhooks/endpoints` | [`CreatedWebhookEndpoint`](src/models/created_webhook_endpoint.rs) |
| `client.webhook_endpoints().endpoints().retrieve(endpoint_id: &str) -> Call<WebhookEndpoint>` | `GET /api/v1/webhooks/endpoints/{endpoint_id}` | [`WebhookEndpoint`](src/models/webhook_endpoint.rs) |
| `client.webhook_endpoints().endpoints().delete(endpoint_id: &str) -> Call<()>` | `DELETE /api/v1/webhooks/endpoints/{endpoint_id}` | nothing |
| `client.webhook_endpoints().endpoints().update(endpoint_id: &str, update_webhook_endpoint_request: UpdateWebhookEndpointRequest) -> Call<WebhookEndpoint>` | `PATCH /api/v1/webhooks/endpoints/{endpoint_id}` | [`WebhookEndpoint`](src/models/webhook_endpoint.rs) |
| `client.webhook_endpoints().endpoints().list_deliveries(endpoint_id: &str, options: impl Into<Option<WebhookEndpointsEndpointsListDeliveriesOptions>>) -> PageCall<WebhookDeliveryListResponse, WebhookDelivery>` | `GET /api/v1/webhooks/endpoints/{endpoint_id}/deliveries` | [`WebhookDeliveryListResponse`](src/models/webhook_delivery_list_response.rs) page of [`WebhookDelivery`](src/models/webhook_delivery.rs) |
| `client.webhook_endpoints().endpoints().rotate_secret(endpoint_id: &str) -> Call<WebhookEndpointSecret>` | `POST /api/v1/webhooks/endpoints/{endpoint_id}/rotate-secret` | [`WebhookEndpointSecret`](src/models/webhook_endpoint_secret.rs) |
| `client.webhook_endpoints().endpoints().retrieve_secret(endpoint_id: &str) -> Call<WebhookEndpointSecret>` | `GET /api/v1/webhooks/endpoints/{endpoint_id}/secret` | [`WebhookEndpointSecret`](src/models/webhook_endpoint_secret.rs) |