{"openapi":"3.0.0","info":{"description":"Digital product sales"},"servers":[{"description":"Digital product sales","url":"https://api.apirails.com/gumroad"}],"paths":{"/v2/products/:product_id/custom_fields":{"get":{"tags":["Custom Fields"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#custom-fields","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/custom_fields"},"summary":"Retrieve all of the existing custom fields for a product","description":"Retrieve all of the existing custom fields for a product","security":[{"bearerAuth":[]}]},"post":{"tags":["Custom Fields"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#custom-fields","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/custom_fields"},"summary":"Create a new custom field for a product","description":"Create a new custom field for a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","required":true},"variant":{"type":"string"}}},"example":{"name":"","variant":""}}}}}},"/v2/products/:product_id/custom_fields/:name":{"put":{"tags":["Custom Fields"],"parameters":[{"name":"name","in":"path","description":"custom Field","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#custom-fields","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/custom_fields/:name"},"summary":"Edit an existing product's custom field","description":"Edit an existing product's custom field","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"variant":{"type":"string","required":true}}},"example":{"variant":""}}}}},"delete":{"tags":["Custom Fields"],"parameters":[{"name":"name","in":"path","description":"custom Field","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#custom-fields","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/custom_fields/:name"},"summary":"Permanently delete a product's custom field","description":"Permanently delete a product's custom field","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/licenses/verify":{"post":{"tags":["Licenses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#licenses","api_endpoint":"https://api.gumroad.com/v2/licenses/verify"},"summary":"Verify a license","description":"Verify a license","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"increment_uses_count":{"type":"boolean","enum":[true,false]},"license_key":{"type":"string","description":"the license key provided by your customer","required":true},"product_id":{"type":"string","description":"the unique ID of the product","required":true}}},"example":{"increment_uses_count":"","license_key":"","product_id":""}}}}}},"/v2/licenses/enable":{"put":{"tags":["Licenses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#licenses","api_endpoint":"https://api.gumroad.com/v2/licenses/enable"},"summary":"Enable a license","description":"Enable a license","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"license_key":{"type":"string","description":"the license key provided by your customer","required":true},"product_id":{"type":"string","description":"the unique ID of the product","required":true}}},"example":{"license_key":"","product_id":""}}}}}},"/v2/licenses/disable":{"put":{"tags":["Licenses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#licenses","api_endpoint":"https://api.gumroad.com/v2/licenses/disable"},"summary":"Disable a license","description":"Disable a license","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"license_key":{"type":"string","description":"the license key provided by your customer","required":true},"product_id":{"type":"string","description":"the unique ID of the product","required":true}}},"example":{"license_key":"","product_id":""}}}}}},"/v2/licenses/decrement_uses_count":{"put":{"tags":["Licenses"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#licenses","api_endpoint":"https://api.gumroad.com/v2/licenses/decrement_uses_count"},"summary":"Decrement the uses count of a license","description":"Decrement the uses count of a license","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"license_key":{"type":"string","description":"the license key provided by your customer","required":true},"product_id":{"type":"string","description":"the unique ID of the product","required":true}}},"example":{"license_key":"","product_id":""}}}}}},"/v2/products/:product_id/offer_codes":{"get":{"tags":["Offer Codes"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#offer-codes","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/offer_codes"},"summary":"Retrieve all of the existing offer codes for a product","description":"Retrieve all of the existing offer codes for a product","security":[{"bearerAuth":[]}]},"post":{"tags":["Offer Codes"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#offer-codes","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/offer_codes"},"summary":"Create a new offer code for a product","description":"Create a new offer code for a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"amount_off":{"type":"string","required":true},"name":{"type":"string","description":"the coupon code used at checkout","required":true},"offer_type":{"type":"string","description":"cents/percent Default-cents\nmax_purchase_count","enum":["string"]}}},"example":{"amount_off":"","name":"","offer_type":""}}}}}},"/v2/products/:product_id/offer_codes/:id":{"get":{"tags":["Offer Codes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ID"]}}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#offer-codes","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/offer_codes/:id"},"summary":"Retrieve the details of a specific offer code of a product","description":"Retrieve the details of a specific offer code of a product","security":[{"bearerAuth":[]}]},"put":{"tags":["Offer Codes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ID"]}}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#offer-codes","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/offer_codes/:id"},"summary":"Edit an existing product's offer code","description":"Edit an existing product's offer code","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"offer_code":{"type":"string","description":"string","enum":["required"]}}},"example":{"offer_code":""}}}}},"delete":{"tags":["Offer Codes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["ID"]}}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#offer-codes","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/offer_codes/:id"},"summary":"Permanently delete a product's offer code","description":"Permanently delete a product's offer code","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/products":{"get":{"tags":["Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#products","api_endpoint":"https://api.gumroad.com/v2/products"},"summary":"Retrieve all of the existing products for the authenticated user","description":"Retrieve all of the existing products for the authenticated user","security":[{"bearerAuth":[]}]}},"/v2/products/:id":{"get":{"tags":["Products"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#products","api_endpoint":"https://api.gumroad.com/v2/products/:id"},"summary":"Retrieve the details of a product","description":"Retrieve the details of a product","security":[{"bearerAuth":[]}]},"delete":{"tags":["Products"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#products","api_endpoint":"https://api.gumroad.com/v2/products/:id"},"summary":"Permanently delete a product","description":"Permanently delete a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/products/:id/enable":{"put":{"tags":["Products"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#products","api_endpoint":"https://api.gumroad.com/v2/products/:id/enable"},"summary":"Enable an existing product","description":"Enable an existing product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/products/:id/disable":{"put":{"tags":["Products"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#products","api_endpoint":"https://api.gumroad.com/v2/products/:id/disable"},"summary":"Disable an existing product","description":"Disable an existing product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/resource_subscriptions":{"put":{"tags":["Resource Subscriptions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#resource-subscriptions","api_endpoint":"https://api.gumroad.com/v2/resource_subscriptions"},"summary":"Subscribe to a resource","description":"Subscribe to a resource","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"charge_occurrence_count":{"type":"string","description":"number of charges made for this subscription"},"created_at":{"type":"string","description":"timestamp when subscription was created"},"custom_fields":{"type":"string","description":"custom fields from the original purchase"},"free_trial_ends_at":{"type":"string","description":"timestamp when free trial ends"},"license_key":{"type":"string","description":"license key from the original purchase."},"product_id":{"type":"string","description":"id of the product"},"product_name":{"type":"string","description":"name of the product"},"purchase_ids":{"type":"string","description":"array of charge ids belonging to this subscription"},"recurrence":{"type":"subscription duration","enum":["monthly","quarterly","biannually","yearly"]},"subscription_id":{"type":"string","description":"id of the subscription"},"user_email":{"type":"string","description":"email address of the subscriber"},"user_id":{"type":"string","description":"user id of the subscriber"}}},"example":{"charge_occurrence_count":"","created_at":"","custom_fields":"","free_trial_ends_at":"","license_key":"","product_id":"","product_name":"","purchase_ids":"","recurrence":"","subscription_id":"","user_email":"","user_id":""}}}}},"get":{"tags":["Resource Subscriptions"],"parameters":[{"name":"resource_name","in":"query","description":"Currently there are 8 supported values - sale; refund; dispute; dispute_won; cancellation; subscription_updated; subscription_ended; and subscription_restarted.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#resource-subscriptions","api_endpoint":"https://api.gumroad.com/v2/resource_subscriptions"},"summary":"Show all active subscriptions of user for the input resource","description":"Show all active subscriptions of user for the input resource","security":[{"bearerAuth":[]}]}},"/v2/resource_subscriptions/:resource_subscription_id":{"delete":{"tags":["Resource Subscriptions"],"parameters":[{"name":"resource_subscription_id","in":"path","description":"Resource subscription ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#resource-subscriptions","api_endpoint":"https://api.gumroad.com/v2/resource_subscriptions/:resource_subscription_id"},"summary":"Unsubscribe from a resource","description":"Unsubscribe from a resource","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/sales":{"get":{"tags":["Sales"],"parameters":[{"name":"after","in":"query","description":"Only return sales after this date. date in form YYYY-MM-DD","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Only return sales before this date. date in form YYYY-MM-DD","schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Filter sales by this email","schema":{"type":"string","example":""}},{"name":"order_id","in":"query","description":"Filter sales by this Order ID","schema":{"type":"string","example":""}},{"name":"page_key","in":"query","description":"A key representing a page of results. It is given in the response as next_page_key.","schema":{"type":"string","example":""}},{"name":"product_id","in":"query","description":"Filter sales by this product","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#sales","api_endpoint":"https://api.gumroad.com/v2/sales"},"summary":"Retrieves all of the successful sales by the authenticated user","description":"Retrieves all of the successful sales by the authenticated user","security":[{"bearerAuth":[]}]}},"/v2/sales/:id":{"get":{"tags":["Sales"],"parameters":[{"name":"id","in":"path","description":"Sales ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#sales","api_endpoint":"https://api.gumroad.com/v2/sales/:id"},"summary":"Retrieves the details of a sale by this user","description":"Retrieves the details of a sale by this user","security":[{"bearerAuth":[]}]}},"/v2/sales/:id/mark_as_shipped":{"put":{"tags":["Sales"],"parameters":[{"name":"id","in":"path","description":"Sales ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#sales","api_endpoint":"https://api.gumroad.com/v2/sales/:id/mark_as_shipped"},"summary":"Marks a sale as shipped","description":"Marks a sale as shipped","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tracking_url":{"type":"string"}}},"example":{"tracking_url":""}}}}}},"/v2/sales/:id/refund":{"put":{"tags":["Sales"],"parameters":[{"name":"id","in":"path","description":"Sales ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#sales","api_endpoint":"https://api.gumroad.com/v2/sales/:id/refund"},"summary":"Refunds a sale","description":"Refunds a sale","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"amount_cents":{"type":"string","description":"Amount in cents (in currency of the sale) to be refunded. If set issue partial refund by this amount. If not set; issue full refund. You can issue multiple partial refunds per sale until it is fully refunded."}}},"example":{"amount_cents":""}}}}}},"/v2/products/:product_id/subscribers":{"get":{"tags":["Subscribers"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Filter subscribers by this email","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#subscribers","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/subscribers"},"summary":"Retrieves all of the active subscribers for one of the authenticated user's products","description":"Retrieves all of the active subscribers for one of the authenticated user's products","security":[{"bearerAuth":[]}]}},"/v2/subscribers/:id":{"get":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Subscribers ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#subscribers","api_endpoint":"https://api.gumroad.com/v2/subscribers/:id"},"summary":"Retrieves the details of a subscriber to this user's product","description":"Retrieves the details of a subscriber to this user's product","security":[{"bearerAuth":[]}]}},"/v2/user":{"get":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#user","api_endpoint":"https://api.gumroad.com/v2/user"},"summary":"Retrieve the user's data","description":"Retrieve the user's data","security":[{"bearerAuth":[]}]}},"/v2/products/:product_id/variant_categories":{"post":{"tags":["Variant Categories"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories"},"summary":"Create a new variant category on a product","description":"Create a new variant category on a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","required":true},"variant_category":{"type":"string","required":true}}},"example":{"title":"","variant_category":""}}}}},"get":{"tags":["Variant Categories"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories"},"summary":"Retrieve all of the existing variant categories of a product","description":"Retrieve all of the existing variant categories of a product","security":[{"bearerAuth":[]}]}},"/v2/products/:product_id/variant_categories/:id":{"get":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:id"},"summary":"Retrieve the details of a variant category of a product","description":"Retrieve the details of a variant category of a product","security":[{"bearerAuth":[]}]},"put":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:id"},"summary":"Edit a variant category of an existing product","description":"Edit a variant category of an existing product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","required":true},"variant_category":{"type":"string","required":true}}},"example":{"title":"","variant_category":""}}}}},"delete":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:id"},"summary":"Permanently delete a variant category of a product","description":"Permanently delete a variant category of a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/products/:product_id/variant_categories/:variant_category_id/variantss":{"post":{"tags":["Variant Categories"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"variant_category_id","in":"path","description":"Variant Category ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:variant_category_id/variantss"},"summary":"Create a new variant of a product","description":"Create a new variant of a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_purchase_count":{"type":"string"},"name":{"type":"string","required":true},"price_difference_cents":{"type":"string","required":true},"variant":{"type":"string","required":true}}},"example":{"max_purchase_count":"","name":"","price_difference_cents":"","variant":""}}}}}},"/v2/products/:product_id/variant_categories/:variant_category_id/variants/:id":{"get":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"variant_category_id","in":"path","description":"Variant Category ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:variant_category_id/variants/:id"},"summary":"Retrieve the details of a variant of a product","description":"Retrieve the details of a variant of a product","security":[{"bearerAuth":[]}]},"put":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"variant_category_id","in":"path","description":"Variant Category ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:variant_category_id/variants/:id"},"summary":"Edit a variant of an existing product","description":"Edit a variant of an existing product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_purchase_count":{"type":"string"},"name":{"type":"string","required":true},"price_difference_cents":{"type":"string","required":true},"variant":{"type":"string","required":true}}},"example":{"max_purchase_count":"","name":"","price_difference_cents":"","variant":""}}}}},"delete":{"tags":["Variant Categories"],"parameters":[{"name":"id","in":"path","description":"ID","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"variant_category_id","in":"path","description":"Variant Category ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:variant_category_id/variants/:id"},"summary":"Permanently delete a variant of a product","description":"Permanently delete a variant of a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/products/:product_id/variant_categories/:variant_category_id/variants":{"get":{"tags":["Variant Categories"],"parameters":[{"name":"product_id","in":"path","description":"Product ID","required":true,"schema":{"type":"string","example":""}},{"name":"variant_category_id","in":"path","description":"Variant Category ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://app.gumroad.com/api#variant-categories","api_endpoint":"https://api.gumroad.com/v2/products/:product_id/variant_categories/:variant_category_id/variants"},"summary":"Retrieve all of the existing variants in a variant category","description":"Retrieve all of the existing variants in a variant category","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}