Skip to content

Tiendup Public API (1.0.0)

API pública para integrar Tiendup 🔑 Para obtener una API Key, sigue los pasos de la documentación:
¿Cómo obtener tu API Key de Tiendup?

Download OpenAPI description
Overview
Languages
Servers
https://{business_slug}.public-api.tiendup.com
Operations
Operations
Operations
Operations
Operations
Operations

Request

Lista productos del tipo suscripción.

Security
ApiKeyAuth
Query
pageinteger>= 1
Default 1
limitinteger[ 1 .. 100 ]
Default 25
curl -i -X GET \
  'https://demo.public-api.tiendup.com/subscriptions?page=1&limit=25' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Listado de suscripciones

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(SubscriptionProduct)required

Lista de suscripciones (si no hay, viene vacío).

data[].​idintegerrequired
Example: 13890
data[].​hashstringrequired
Example: "p1EEBp"
data[].​namestringrequired
Example: "suscripcion"
data[].​short_descriptionstring or null
data[].​pricestringrequired
Example: "0"
data[].​price_minstring or null
data[].​price_maxstring or null
data[].​prices_list_keystring or null
data[].​base_pricestringrequired
Example: "0"
data[].​price_variesbooleanrequired
Example: false
data[].​compare_at_pricestring or null
data[].​price_visiblebooleanrequired
Example: true
data[].​currencystringrequired
Example: "ARS"
data[].​ecommerce_typestringrequired
Value"subscription"
Example: "subscription"
data[].​skustring or null
data[].​slugstringrequired
Example: "suscripcion"
data[].​activebooleanrequired
Example: true
data[].​ratingnumber
Example: 0
data[].​reviewsinteger
Example: 0
data[].​salesinteger
Example: 0
data[].​tagsstring
Example: ""
data[].​imageImage (object) or boolean
One of:
data[].​egiftboolean
Example: false
data[].​is_variantboolean
Example: false
data[].​has_variantsboolean
Example: true
data[].​vendorstring or null
data[].​stock_managementboolean
Example: false
data[].​subscription_kpisobject(SubscriptionKpis)
data[].​sales_channelobject
data[].​is_buyableboolean
Example: true
data[].​publishedboolean
Example: true
data[].​categoriesArray of any
Example: []
data[].​property name*anyadditional property
countFilteredinteger or stringrequired
Example: "1"
One of:
integer
countinteger or stringrequired
Example: "1"
One of:
integer
previousintegerrequired
Example: 1
currentintegerrequired
Example: 1
pagesintegerrequired
Example: 1
nextintegerrequired
Example: 1
property name*anyadditional property
Response
application/json
{ "status": "OK", "data": [ {} ], "countFiltered": "1", "count": "1", "previous": 1, "current": 1, "pages": 1, "next": 1 }

Request

Lista los suscriptores de un producto de suscripción (paginado).

Security
ApiKeyAuth
Path
product_idintegerrequired
Example: 13890
Query
pageinteger>= 1
Default 1
limitinteger[ 1 .. 100 ]
Default 25
curl -i -X GET \
  'https://demo.public-api.tiendup.com/subscriptions/13890/subscribers?page=1&limit=25' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Listado de suscriptores

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(SubscriptionSubscriber)required
data[].​idintegerrequired
Example: 2903
data[].​statusstringrequired
Example: "inactive"
data[].​activebooleanrequired
Example: false
data[].​statsobject(SubscriptionSubscriberStats)required
data[].​stats.​trialsintegerrequired
Example: 0
data[].​stats.​trials_limitintegerrequired
Example: 1
data[].​stats.​property name*anyadditional property
data[].​productobject(SubscriptionVariantProduct)required
data[].​product.​idintegerrequired
Example: 13644
data[].​product.​ecommerce_typestringrequired
Value"subscription"
Example: "subscription"
data[].​product.​slugstringrequired
Example: "plan-integral"
data[].​product.​skustring or null
data[].​product.​namestringrequired
Example: "Membresia Holistica Yoga Studio (Plan integral)"
data[].​product.​activebooleanrequired
Example: true
data[].​product.​short_descriptionstring or null
data[].​product.​variant_idintegerrequired
Example: 13644
data[].​product.​product_idintegerrequired
Example: 13643
data[].​product.​product_namestringrequired
Example: "Membresia Holistica Yoga Studio"
data[].​product.​variant_namestringrequired
Example: "Plan integral"
data[].​product.​imageImage (object) or boolean
One of:
data[].​product.​property name*anyadditional property
data[].​status_change_datestring or null
Example: "2026-02-22 23:40:27"
data[].​current_period_startstring or null
Example: "2025-09-11 15:16:01"
data[].​current_period_endstring or null
Example: "2025-10-11 15:16:01"
data[].​start_datestring or null
Example: "2026-02-22 23:40:27"
data[].​payment_statusstring or null
Example: "pending"
data[].​is_trialboolean
Example: false
data[].​trial_period_end_datestring or null
Example: "2026-02-22 23:40:27"
data[].​billing_typestring or null
Example: "charge_automatically"
data[].​schedule_typestring or null
Example: "monthly"
data[].​currencystring or null
Example: "ARS"
data[].​currency_symbolstring or null
Example: "$"
data[].​total_amountstring or null
Example: "22000"
data[].​has_payment_sourceboolean or null
Example: false
data[].​payment_attemptsinteger
Example: 0
data[].​next_payment_attemptstring or null
data[].​has_payment_attempts_leftboolean or null
data[].​subscriptionobject(SubscriptionPaymentSnapshot)required
data[].​subscription.​idintegerrequired
Example: 2903
data[].​subscription.​status_change_datestring or null
data[].​subscription.​current_period_startstring or null
data[].​subscription.​current_period_endstring or null
data[].​subscription.​start_datestring or null
data[].​subscription.​payment_statusstring or null
data[].​subscription.​is_trialboolean or null
data[].​subscription.​trial_period_end_datestring or null
data[].​subscription.​billing_typestring or null
data[].​subscription.​schedule_typestring or null
data[].​subscription.​currencystring or null
data[].​subscription.​currency_symbolstring or null
data[].​subscription.​total_amountstring or null
data[].​subscription.​has_payment_sourceboolean or null
data[].​subscription.​payment_attemptsinteger or null
data[].​subscription.​next_payment_attemptstring or null
data[].​subscription.​has_payment_attempts_leftboolean or null
data[].​subscription.​property name*anyadditional property
data[].​customerobject(CustomerMini)required
data[].​customer.​idintegerrequired
Example: 41927
data[].​customer.​namestringrequired
Example: "Anna"
data[].​customer.​last_namestring or null
Example: "Laura"
data[].​customer.​emailstringrequired
Example: "customer6@example.com"
data[].​customer.​phonestring or null
Example: "+1 202 555 1003"
data[].​customer.​property name*anyadditional property
data[].​property name*anyadditional property
countFilteredinteger or stringrequired
Example: 32
One of:
integer
countinteger or stringrequired
Example: "32"
One of:
integer
previousintegerrequired
Example: 1
currentintegerrequired
Example: 1
pagesintegerrequired
Example: 2
nextintegerrequired
Example: 2
property name*anyadditional property
Response
application/json
{ "status": "OK", "data": [ {} ], "countFiltered": 32, "count": "32", "previous": 1, "current": 1, "pages": 2, "next": 2 }

Request

Obtiene el estado completo de una suscripción específica.

Security
ApiKeyAuth
Path
subscription_idintegerrequired
Example: 2903
curl -i -X GET \
  https://demo.public-api.tiendup.com/subscriptions/2903 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Subscription detail

Bodyapplication/json
statusstringrequired
Example: "OK"
dataobject(SubscriptionDetail)required
data.​idintegerrequired
Example: 2903
data.​hashstring
Example: "dgwndCoN8W"
data.​numberstring
Example: "38"
data.​statusstringrequired
Example: "inactive"
data.​activebooleanrequired
Example: false
data.​payment_statusstringrequired
Example: "pending"
data.​next_payment_attemptstring or null
data.​payment_attemptsinteger or string
Example: "0"
One of:
integer
data.​next_invoice_datestring or null
data.​end_datestring or null
data.​automatic_renewalboolean
Example: true
data.​creation_datestring
data.​trial_period_start_datestring or null
data.​trial_period_end_datestring or null
data.​billing_typestring
Example: "charge_automatically"
data.​current_period_startstring or null
data.​current_period_endstring or null
data.​installmentsinteger
Example: 1
data.​total_periodsinteger
data.​total_paid_periodsinteger
data.​activation_datestring or null
data.​days_until_dueinteger
data.​authorization_requiredboolean
data.​language_isostring
Example: "es"
data.​cancellation_datestring or null
data.​cancellation_policystring or null
data.​cancel_atstring or null
data.​pay_urlstring or null
data.​is_trialboolean
data.​is_freeboolean
data.​current_invoiceobject(SubscriptionInvoice)
data.​gatewayobject(PaymentGateway)
data.​billing_agreementobject or null
data.​external_plan_registeredboolean
data.​billing_planobject(BillingPlan)
data.​itemsArray of objects(SubscriptionItem)
data.​total_itemsinteger
data.​currencystring
data.​currency_symbolstring
data.​pricing_periodobject(PricingPeriod)
data.​customerobject(CustomerFull)
data.​sales_channelobject(SalesChannel)
data.​historyArray of objects
data.​property name*anyadditional property
Response
application/json
{ "status": "OK", "data": { "id": 2903, "hash": "dgwndCoN8W", "number": "38", "status": "inactive", "active": false, "payment_status": "pending", "next_payment_attempt": "string", "payment_attempts": "0", "next_invoice_date": "string", "end_date": "string", "automatic_renewal": true, "creation_date": "string", "trial_period_start_date": "string", "trial_period_end_date": "string", "billing_type": "charge_automatically", "current_period_start": "string", "current_period_end": "string", "installments": 1, "total_periods": 0, "total_paid_periods": 0, "activation_date": "string", "days_until_due": 0, "authorization_required": true, "language_iso": "es", "cancellation_date": "string", "cancellation_policy": "string", "cancel_at": "string", "pay_url": "string", "is_trial": true, "is_free": true, "current_invoice": {}, "gateway": {}, "billing_agreement": {}, "external_plan_registered": true, "billing_plan": {}, "items": [], "total_items": 0, "currency": "string", "currency_symbol": "string", "pricing_period": {}, "customer": {}, "sales_channel": {}, "history": [] } }
Operations