Every operation of the API, as a method of a Meteroid client (client below), by
resource. Optional parameters ([...]) go in an immutable options object an overload leaves out,
and each method has overloads taking a last RequestOptions for the headers, timeout, retries or
idempotency key of that call. client.async() has the same methods returning
CompletableFutures, and client.withRawResponse() returning ApiResponses. Models are in
com.meteroid.models
A paginated list returns a page: the getters of its response body (page.data()), its items
(page.items()), hasNextPage() and nextPage(). Iterating it, or its stream(), yields every
item from that page on, and pages() every page, fetching the next ones on demand. body() is
the response body as received. The async client's pages have nextPage(), forEach(...),
forEachPage(...) and toList(), returning CompletableFutures.
Add ons · Add ons entitlements · Batch jobs · Checkout sessions · Connect · Coupons · Credit notes · Custom properties · Customers · Entitlements · Events · Features · Invoices · Metrics · Oauth · Oauth apps · Plans · Plans versions · Product families · Products · Products entitlements · Subscriptions · Usage · Webhook endpoints · Webhook endpoints endpoints
client.addOns()
Method
Request
Returns
AddOnsListPage client.addOns().list([AddOnsListOptions options])GET /api/v1/addonspage of AddOnAddOnListResponse
AddOn client.addOns().create(CreateAddOnRequest createAddOnRequest)POST /api/v1/addonsAddOn
AddOn client.addOns().retrieve(String addonId)GET /api/v1/addons/{addon_id}AddOn
AddOn client.addOns().update(String addonId, UpdateAddOnRequest updateAddOnRequest)PATCH /api/v1/addons/{addon_id}AddOn
void client.addOns().archive(String addonId)POST /api/v1/addons/{addon_id}/archivenothing
void client.addOns().unarchive(String addonId)POST /api/v1/addons/{addon_id}/unarchivenothing
client.addOns().entitlements()
Method
Request
Returns
ResolvedEntitlementListResponse client.addOns().entitlements().list(String addonId)GET /api/v1/addons/{addon_id}/entitlementsResolvedEntitlementListResponse
EntitlementListResponse client.addOns().entitlements().create(String addonId, CreateEntitlementsRequest createEntitlementsRequest)POST /api/v1/addons/{addon_id}/entitlementsEntitlementListResponse
client.batchJobs()
client.checkoutSessions()
Method
Request
Returns
ListCheckoutSessionsResponse client.checkoutSessions().list([CheckoutSessionsListOptions options])GET /api/v1/checkout-sessionsListCheckoutSessionsResponse
CreateCheckoutSessionResponse client.checkoutSessions().create(CreateCheckoutSessionRequest createCheckoutSessionRequest)POST /api/v1/checkout-sessionsCreateCheckoutSessionResponse
GetCheckoutSessionResponse client.checkoutSessions().retrieve(String id)GET /api/v1/checkout-sessions/{id}GetCheckoutSessionResponse
CancelCheckoutSessionResponse client.checkoutSessions().cancel(String id)POST /api/v1/checkout-sessions/{id}/cancelCancelCheckoutSessionResponse
client.connect()
Method
Request
Returns
ConnectedAccountsResponse client.connect().listConnectedAccounts()GET /api/v1/connected-accountsConnectedAccountsResponse
ConnectedAccount client.connect().createConnectedAccount(CreateConnectedAccountRequest createConnectedAccountRequest)POST /api/v1/connected-accountsConnectedAccount
ConnectedAccount client.connect().retrieveConnectedAccount(String id)GET /api/v1/connected-accounts/{id}ConnectedAccount
void client.connect().disconnectAccount(String id)DELETE /api/v1/connected-accounts/{id}nothing
OnboardingLinkResponse client.connect().createOnboardingLink(String id, CreateOnboardingLinkRequest createOnboardingLinkRequest)POST /api/v1/connected-accounts/{id}/onboardingOnboardingLinkResponse
client.coupons()
Method
Request
Returns
CouponsListPage client.coupons().list([CouponsListOptions options])GET /api/v1/couponspage of CouponCouponListResponse
Coupon client.coupons().create(CreateCouponRequest createCouponRequest)POST /api/v1/couponsCoupon
Coupon client.coupons().retrieve(String couponId)GET /api/v1/coupons/{coupon_id}Coupon
Coupon client.coupons().update(String couponId, UpdateCouponRequest updateCouponRequest)PATCH /api/v1/coupons/{coupon_id}Coupon
void client.coupons().archive(String couponId)POST /api/v1/coupons/{coupon_id}/archivenothing
void client.coupons().disable(String couponId)POST /api/v1/coupons/{coupon_id}/disablenothing
void client.coupons().enable(String couponId)POST /api/v1/coupons/{coupon_id}/enablenothing
void client.coupons().unarchive(String couponId)POST /api/v1/coupons/{coupon_id}/unarchivenothing
client.creditNotes()
Method
Request
Returns
CreditNotesListPage client.creditNotes().list([CreditNotesListOptions options])GET /api/v1/credit-notespage of CreditNoteCreditNoteListResponse
CreditNote client.creditNotes().retrieve(String creditNoteId)GET /api/v1/credit-notes/{credit_note_id}CreditNote
CreditNote client.creditNotes().updateCustomProperties(String creditNoteId, CreditNoteCustomPropertiesRequest creditNoteCustomPropertiesRequest)PATCH /api/v1/credit-notes/{credit_note_id}/custom-propertiesCreditNote
byte[] client.creditNotes().download(String creditNoteId)GET /api/v1/credit-notes/{credit_note_id}/downloadbytes
byte[] client.creditNotes().downloadXml(String creditNoteId)GET /api/v1/credit-notes/{credit_note_id}/xmlbytes
client.customProperties()
Method
Request
Returns
CustomPropertiesListCustomPropertyDefinitionsPage client.customProperties().listCustomPropertyDefinitions([CustomPropertiesListCustomPropertyDefinitionsOptions options])GET /api/v1/custom-property-definitionspage of CustomPropertyDefinitionCustomPropertyDefinitionListResponse
CustomPropertyDefinition client.customProperties().createCustomPropertyDefinition(CustomPropertyDefinitionCreateRequest customPropertyDefinitionCreateRequest)POST /api/v1/custom-property-definitionsCustomPropertyDefinition
CustomPropertyDefinition client.customProperties().retrieveCustomPropertyDefinition(String id)GET /api/v1/custom-property-definitions/{id}CustomPropertyDefinition
CustomPropertyDefinition client.customProperties().updateCustomPropertyDefinition(String id, CustomPropertyDefinitionUpdateRequest customPropertyDefinitionUpdateRequest)PUT /api/v1/custom-property-definitions/{id}CustomPropertyDefinition
CustomPropertyDefinition client.customProperties().archiveDefinition(String id)DELETE /api/v1/custom-property-definitions/{id}CustomPropertyDefinition
client.customers()
Method
Request
Returns
CustomersListPage client.customers().list([CustomersListOptions options])GET /api/v1/customerspage of CustomerCustomerListResponse
Customer client.customers().create(CustomerCreateRequest customerCreateRequest)POST /api/v1/customersCustomer
Customer client.customers().retrieve(String idOrAlias)GET /api/v1/customers/{id_or_alias}Customer
Customer client.customers().replace(String idOrAlias, CustomerUpdateRequest customerUpdateRequest)PUT /api/v1/customers/{id_or_alias}Customer
void client.customers().archive(String idOrAlias)DELETE /api/v1/customers/{id_or_alias}nothing
Customer client.customers().update(String idOrAlias, CustomerPatchRequest customerPatchRequest)PATCH /api/v1/customers/{id_or_alias}Customer
EffectiveEntitlementListResponse client.customers().listEntitlements(String idOrAlias)GET /api/v1/customers/{id_or_alias}/entitlementsEffectiveEntitlementListResponse
CustomerPortalTokenResponse client.customers().createPortalToken(String idOrAlias, CustomerPortalTokenRequest customerPortalTokenRequest)POST /api/v1/customers/{id_or_alias}/portal-tokenCustomerPortalTokenResponse
void client.customers().unarchive(String idOrAlias)POST /api/v1/customers/{id_or_alias}/unarchivenothing
client.entitlements()
Method
Request
Returns
Entitlement client.entitlements().retrieve(String entitlementId)GET /api/v1/entitlements/{entitlement_id}Entitlement
void client.entitlements().delete(String entitlementId)DELETE /api/v1/entitlements/{entitlement_id}nothing
Entitlement client.entitlements().update(String entitlementId, UpdateEntitlementRequest updateEntitlementRequest)PATCH /api/v1/entitlements/{entitlement_id}Entitlement
client.events()
Method
Request
Returns
IngestEventsResponse client.events().ingest(IngestEventsRequest ingestEventsRequest)POST /api/v1/events/ingestIngestEventsResponse
client.features()
Method
Request
Returns
FeaturesListPage client.features().list([FeaturesListOptions options])GET /api/v1/featurespage of FeatureFeatureListResponse
Feature client.features().create(CreateFeatureRequest createFeatureRequest)POST /api/v1/featuresFeature
Feature client.features().retrieve(String idOrCode)GET /api/v1/features/{id_or_code}Feature
Feature client.features().update(String idOrCode, UpdateFeatureRequest updateFeatureRequest)PATCH /api/v1/features/{id_or_code}Feature
void client.features().archive(String idOrCode)POST /api/v1/features/{id_or_code}/archivenothing
void client.features().unarchive(String idOrCode)POST /api/v1/features/{id_or_code}/unarchivenothing
client.invoices()
Method
Request
Returns
InvoicesListPage client.invoices().list([InvoicesListOptions options])GET /api/v1/invoicespage of InvoiceInvoiceListResponse
Invoice client.invoices().retrieve(String invoiceId)GET /api/v1/invoices/{invoice_id}Invoice
Invoice client.invoices().updateCustomProperties(String invoiceId, InvoiceCustomPropertiesRequest invoiceCustomPropertiesRequest)PATCH /api/v1/invoices/{invoice_id}/custom-propertiesInvoice
byte[] client.invoices().download(String invoiceId)GET /api/v1/invoices/{invoice_id}/downloadbytes
Invoice client.invoices().refresh(String invoiceId)POST /api/v1/invoices/{invoice_id}/refreshInvoice
byte[] client.invoices().downloadXml(String invoiceId)GET /api/v1/invoices/{invoice_id}/xmlbytes
client.metrics()
Method
Request
Returns
MetricsListPage client.metrics().list([MetricsListOptions options])GET /api/v1/metricspage of MetricSummaryMetricListResponse
Metric client.metrics().create(CreateMetricRequest createMetricRequest)POST /api/v1/metricsMetric
Metric client.metrics().retrieve(String metricId)GET /api/v1/metrics/{metric_id}Metric
Metric client.metrics().update(String metricId, UpdateMetricRequest updateMetricRequest)PATCH /api/v1/metrics/{metric_id}Metric
void client.metrics().archive(String metricId)POST /api/v1/metrics/{metric_id}/archivenothing
void client.metrics().unarchive(String metricId)POST /api/v1/metrics/{metric_id}/unarchivenothing
client.oauth()
Method
Request
Returns
TokenIntrospectionResponse client.oauth().introspect(IntrospectionRequest introspectionRequest)POST /api/v1/oauth/introspectTokenIntrospectionResponse
void client.oauth().revoke(RevocationRequest revocationRequest)POST /api/v1/oauth/revokenothing
TokenResponse client.oauth().token(TokenRequest tokenRequest)POST /api/v1/oauth/tokenTokenResponse
client.oauthApps()
Method
Request
Returns
OAuthAppsResponse client.oauthApps().list()GET /api/v1/oauth-appsOAuthAppsResponse
OAuthAppWithSecret client.oauthApps().create(CreateOAuthAppRequest createOAuthAppRequest)POST /api/v1/oauth-appsOAuthAppWithSecret
OAuthApp client.oauthApps().retrieve(String id)GET /api/v1/oauth-apps/{id}OAuthApp
void client.oauthApps().delete(String id)DELETE /api/v1/oauth-apps/{id}nothing
RotatedSecret client.oauthApps().rotate(String id)POST /api/v1/oauth-apps/{id}/rotateRotatedSecret
client.plans()
Method
Request
Returns
ResolvedEntitlementListResponse client.plans().listPlanVersionEntitlements(String planVersionId)GET /api/v1/plan-versions/{plan_version_id}/entitlementsResolvedEntitlementListResponse
EntitlementListResponse client.plans().createPlanVersionEntitlement(String planVersionId, CreateEntitlementsRequest createEntitlementsRequest)POST /api/v1/plan-versions/{plan_version_id}/entitlementsEntitlementListResponse
PlansListPage client.plans().list([PlansListOptions options])GET /api/v1/planspage of PlanPlanListResponse
Plan client.plans().create(CreatePlanRequest createPlanRequest)POST /api/v1/plansPlan
Plan client.plans().retrieve(String planId, [PlansRetrieveOptions options])GET /api/v1/plans/{plan_id}Plan
Plan client.plans().replace(String planId, ReplacePlanRequest replacePlanRequest)PUT /api/v1/plans/{plan_id}Plan
Plan client.plans().update(String planId, PatchPlanRequest patchPlanRequest)PATCH /api/v1/plans/{plan_id}Plan
void client.plans().archive(String planId)POST /api/v1/plans/{plan_id}/archivenothing
Plan client.plans().publish(String planId)POST /api/v1/plans/{plan_id}/publishPlan
void client.plans().unarchive(String planId)POST /api/v1/plans/{plan_id}/unarchivenothing
client.plans().versions()
Method
Request
Returns
MinimumCommitment client.plans().versions().updateMinimum(String planVersionId, MinimumCommitment minimumCommitment)PUT /api/v1/plans/versions/{plan_version_id}/minimumMinimumCommitment
void client.plans().versions().deleteMinimum(String planVersionId)DELETE /api/v1/plans/versions/{plan_version_id}/minimumnothing
PlansVersionsListPage client.plans().versions().list(String planId, [PlansVersionsListOptions options])GET /api/v1/plans/{plan_id}/versionspage of PlanVersionSummaryPlanVersionListResponse
client.productFamilies()
Method
Request
Returns
ProductFamiliesListPage client.productFamilies().list([ProductFamiliesListOptions options])GET /api/v1/product_familiespage of ProductFamilyProductFamilyListResponse
ProductFamily client.productFamilies().create(ProductFamilyCreateRequest productFamilyCreateRequest)POST /api/v1/product_familiesProductFamily
ProductFamily client.productFamilies().retrieve(String idOrAlias)GET /api/v1/product_families/{id_or_alias}ProductFamily
client.products()
Method
Request
Returns
ProductsListPage client.products().list([ProductsListOptions options])GET /api/v1/productspage of ProductProductListResponse
Product client.products().create(CreateProductRequest createProductRequest)POST /api/v1/productsProduct
Product client.products().retrieve(String productId)GET /api/v1/products/{product_id}Product
Product client.products().update(String productId, UpdateProductRequest updateProductRequest)PATCH /api/v1/products/{product_id}Product
void client.products().archive(String productId)POST /api/v1/products/{product_id}/archivenothing
void client.products().unarchive(String productId)POST /api/v1/products/{product_id}/unarchivenothing
client.products().entitlements()
Method
Request
Returns
ResolvedEntitlementListResponse client.products().entitlements().list(String productId)GET /api/v1/products/{product_id}/entitlementsResolvedEntitlementListResponse
EntitlementListResponse client.products().entitlements().create(String productId, CreateEntitlementsRequest createEntitlementsRequest)POST /api/v1/products/{product_id}/entitlementsEntitlementListResponse
client.subscriptions()
Method
Request
Returns
SubscriptionsListPage client.subscriptions().list([SubscriptionsListOptions options])GET /api/v1/subscriptionspage of SubscriptionSubscriptionListResponse
SubscriptionDetails client.subscriptions().create(SubscriptionCreateRequest subscriptionCreateRequest)POST /api/v1/subscriptionsSubscriptionDetails
SubscriptionDetails client.subscriptions().retrieve(String subscriptionId)GET /api/v1/subscriptions/{subscription_id}SubscriptionDetails
SubscriptionUpdateResponse client.subscriptions().update(String subscriptionId, SubscriptionUpdateRequest subscriptionUpdateRequest)PATCH /api/v1/subscriptions/{subscription_id}SubscriptionUpdateResponse
CancelSubscriptionResponse client.subscriptions().cancel(String subscriptionId, CancelSubscriptionRequest cancelSubscriptionRequest)POST /api/v1/subscriptions/{subscription_id}/cancelCancelSubscriptionResponse
EffectiveEntitlementListResponse client.subscriptions().listEntitlements(String subscriptionId)GET /api/v1/subscriptions/{subscription_id}/entitlementsEffectiveEntitlementListResponse
Subscription client.subscriptions().retrieveSummary(String subscriptionId)GET /api/v1/subscriptions/{subscription_id}/summarySubscription
client.usage()
Method
Request
Returns
UsageResponse client.usage().retrieveCustomer(String customerId, LocalDate startDate, LocalDate endDate, [UsageRetrieveCustomerOptions options])GET /api/v1/usage/customer/{customer_id}UsageResponse
UsageResponse client.usage().retrieveSubscription(String subscriptionId, [UsageRetrieveSubscriptionOptions options])GET /api/v1/usage/subscription/{subscription_id}UsageResponse
UsageResponse client.usage().retrieveSummary(LocalDate startDate, LocalDate endDate, [UsageRetrieveSummaryOptions options])GET /api/v1/usage/summaryUsageResponse
client.webhookEndpoints()
Method
Request
Returns
WebhookDelivery client.webhookEndpoints().resendWebhookDelivery(String deliveryId)POST /api/v1/webhooks/deliveries/{delivery_id}/resendWebhookDelivery
Webhook endpoints endpoints client.webhookEndpoints().endpoints()
Method
Request
Returns
WebhookEndpointListResponse client.webhookEndpoints().endpoints().list()GET /api/v1/webhooks/endpointsWebhookEndpointListResponse
CreatedWebhookEndpoint client.webhookEndpoints().endpoints().create(CreateWebhookEndpointRequest createWebhookEndpointRequest)POST /api/v1/webhooks/endpointsCreatedWebhookEndpoint
WebhookEndpoint client.webhookEndpoints().endpoints().retrieve(String endpointId)GET /api/v1/webhooks/endpoints/{endpoint_id}WebhookEndpoint
void client.webhookEndpoints().endpoints().delete(String endpointId)DELETE /api/v1/webhooks/endpoints/{endpoint_id}nothing
WebhookEndpoint client.webhookEndpoints().endpoints().update(String endpointId, UpdateWebhookEndpointRequest updateWebhookEndpointRequest)PATCH /api/v1/webhooks/endpoints/{endpoint_id}WebhookEndpoint
WebhookEndpointsEndpointsListDeliveriesPage client.webhookEndpoints().endpoints().listDeliveries(String endpointId, [WebhookEndpointsEndpointsListDeliveriesOptions options])GET /api/v1/webhooks/endpoints/{endpoint_id}/deliveriespage of WebhookDeliveryWebhookDeliveryListResponse
WebhookEndpointSecret client.webhookEndpoints().endpoints().rotateSecret(String endpointId)POST /api/v1/webhooks/endpoints/{endpoint_id}/rotate-secretWebhookEndpointSecret
WebhookEndpointSecret client.webhookEndpoints().endpoints().retrieveSecret(String endpointId)GET /api/v1/webhooks/endpoints/{endpoint_id}/secretWebhookEndpointSecret