sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-06-01 00:00:30 -04:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI spec

Browse Source
This commit is contained in:
Brandur 2017-02-02 16:50:12 -08:00
parent d101b3a7a1
commit b1adb9a1e9
4 changed files with 838 additions and 340 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

209
spec/fixtures.json
View File

@ -19,7 +19,7 @@
"default_currency": "usd",
"details_submitted": false,
"display_name": "",
"email": "foo+6tr1wkwhs5@example.com",
"email": "foo+cerbmuaoim@example.com",
"external_accounts": {
"object": "list",
"data": [
@ -27,10 +27,10 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/accounts/acct_19iWLDAjmyEWNT5f/external_accounts"
"url": "/v1/accounts/acct_19iv7VAuZCWcFwx6/external_accounts"
},
"fake_account": false,
"id": "acct_19iWLDAjmyEWNT5f",
"id": "acct_19iv7VAuZCWcFwx6",
"legal_entity": {
"additional_owners": null,
"address": {
@ -138,11 +138,11 @@
"default_currency": "usd",
"details_submitted": false,
"display_name": "",
"email": "foo+6tr1wkwhs5@example.com",
"email": "foo+cerbmuaoim@example.com",
"external_accounts": {
},
"fake_account": false,
"id": "acct_19iWLDAjmyEWNT5f",
"id": "acct_19iv7VAuZCWcFwx6",
"keys": {
},
"legal_entity": {
@ -177,8 +177,8 @@
"alipay_account": {
"created": 1234567890,
"customer": "",
"fingerprint": "UyfN2VnPBRhl8Uc1",
"id": "aliacc_19iWLcAjmyEWNT5fIaupbq3w",
"fingerprint": "GZkE72X71rg717Fi",
"id": "aliacc_19iv7gAuZCWcFwx64HTDib4u",
"livemode": false,
"metadata": {
},
@ -192,7 +192,7 @@
"apple_pay_domain": {
"created": 1234567890,
"domain_name": "example.com",
"id": "apwc_19iWLPAjmyEWNT5fuAhdxHXu",
"id": "apwc_19iv7cAuZCWcFwx61x1XyMsU",
"livemode": true,
"object": "apple_pay_domain"
},
@ -233,18 +233,11 @@
"fee_details": [
],
"id": "txn_19iWLSAjmyEWNT5fyyQFYAhF",
"id": "txn_19iv7cAuZCWcFwx6GAaWDtqL",
"net": 100,
"object": "balance_transaction",
"source": "ch_19iWLSAjmyEWNT5fpPrjyMyO",
"source": "ch_19iv7cAuZCWcFwx6v5Me3pHJ",
"sourced_transfers": {
"object": "list",
"data": [
],
"has_more": false,
"total_count": 0,
"url": "/v1/transfers?source_transaction=ch_19iWLSAjmyEWNT5fpPrjyMyO"
},
"status": "pending",
"type": "charge"
@ -262,7 +255,7 @@
"description": "Receiver for John Doe",
"email": "test@example.com",
"filled": false,
"id": "btcrcv_19iWLcAjmyEWNT5fUJoSrfl3",
"id": "btcrcv_19iv7gAuZCWcFwx6IUmMP6gm",
"inbound_address": "test_7i9Fo4b5wXcUAuoVBFrc7nc9HDxD1",
"livemode": false,
"metadata": {
@ -280,9 +273,9 @@
"bitcoin_amount": 1757908,
"created": 1234567890,
"currency": "usd",
"id": "btctxn_19iWLcAjmyEWNT5fdOVxwSNn",
"id": "btctxn_19iv7gAuZCWcFwx6t5Z5fyPD",
"object": "bitcoin_transaction",
"receiver": "btcrcv_19iWLcBDdAnyIRNM2oInqd5C"
"receiver": "btcrcv_19iv7gBAJmXANnYTogK4b2o1"
},
"charge": {
"alternate_statement_descriptors": {
@ -295,7 +288,7 @@
"application_fee": "",
"application_fees_refunded": 0,
"authorization_code": "",
"balance_transaction": "txn_19iWLSAjmyEWNT5fyyQFYAhF",
"balance_transaction": "txn_19iv7cAuZCWcFwx6GAaWDtqL",
"captured": true,
"card": {
},
@ -312,7 +305,7 @@
},
"fraud_details": {
},
"id": "ch_19iWLSAjmyEWNT5fpPrjyMyO",
"id": "ch_19iv7cAuZCWcFwx6v5Me3pHJ",
"invoice": "",
"level3": {
},
@ -335,13 +328,13 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/charges/ch_19iWLSAjmyEWNT5fpPrjyMyO/refunds"
"url": "/v1/charges/ch_19iv7cAuZCWcFwx6v5Me3pHJ/refunds"
},
"review": "",
"shipping": {
},
"source": {
"id": "card_19iWLPAjmyEWNT5fu8eGG69r",
"id": "card_19iv7cAuZCWcFwx6OD2d1s1g",
"object": "card",
"address_city": null,
"address_country": null,
@ -451,7 +444,7 @@
"discount": {
},
"email": "",
"id": "cus_A2bY2OHVFr2450",
"id": "cus_A319VR7LsNNR72",
"livemode": false,
"metadata": {
},
@ -465,7 +458,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/customers/cus_A2bY2OHVFr2450/sources"
"url": "/v1/customers/cus_A319VR7LsNNR72/sources"
},
"subscription": {
},
@ -476,13 +469,13 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/customers/cus_A2bY2OHVFr2450/subscriptions"
"url": "/v1/customers/cus_A319VR7LsNNR72/subscriptions"
},
"trust": {
}
},
"customer_source": {
"id": "ba_19iWLcAjmyEWNT5fx5IXF5C7",
"id": "ba_19iv7gAuZCWcFwx6IYsLdLWX",
"metadata": {
},
"object": "bank_account"
@ -492,7 +485,7 @@
"id": "25OFF",
"object": "coupon",
"amount_off": null,
"created": 1485987184,
"created": 1486082420,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
@ -505,7 +498,7 @@
"times_redeemed": 0,
"valid": true
},
"customer": "cus_A2bY2OHVFr2450",
"customer": "cus_A319VR7LsNNR72",
"end": 1234567890,
"object": "discount",
"start": 1234567890,
@ -517,7 +510,7 @@
"balance_transactions": [
],
"charge": "ch_19iWLSAjmyEWNT5fpPrjyMyO",
"charge": "ch_19iv7cAuZCWcFwx6v5Me3pHJ",
"created": 1234567890,
"currency": "usd",
"evidence": {
@ -550,12 +543,12 @@
"uncategorized_text": null
},
"evidence_details": {
"due_by": 1487635199,
"due_by": 1487807999,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
"id": "dp_19iWLTAjmyEWNT5fbvh8ItBH",
"id": "dp_19iv7dAuZCWcFwx6sZh5WWtK",
"is_charge_refundable": false,
"is_protected": false,
"livemode": false,
@ -575,7 +568,7 @@
"id": "gold",
"object": "plan",
"amount": 2000,
"created": 1485987183,
"created": 1486082419,
"currency": "usd",
"interval": "month",
"interval_count": 1,
@ -587,7 +580,7 @@
"trial_period_days": null
}
},
"id": "evt_19iWLdAjmyEWNT5f6lHK5wuz",
"id": "evt_19iv7gAuZCWcFwx6NGKDgMWm",
"livemode": false,
"object": "event",
"pending_webhooks": 0,
@ -596,7 +589,7 @@
"type": "plan.created"
},
"external_account_source": {
"account": "acct_19iWLDAjmyEWNT5f",
"account": "acct_19iv7VAuZCWcFwx6",
"address_city": "",
"address_line1": "",
"address_line2": "",
@ -605,8 +598,8 @@
"country": "US",
"currency": "usd",
"default_for_currency": false,
"fingerprint": "fB7ehthnhvdT83AO",
"id": "ba_19iWLcAjmyEWNT5fx5IXF5C7",
"fingerprint": "8yXS6VWD4NBrVfq4",
"id": "ba_19iv7gAuZCWcFwx6IYsLdLWX",
"last4": "6789",
"metadata": {
},
@ -617,8 +610,8 @@
"balance_transaction": "",
"created": 1234567890,
"currency": "usd",
"fee": "fee_A2bYLQ7I4mX4yy",
"id": "fr_A2bYnoyKK3nTDF",
"fee": "fee_19iv7gAuZCWcFwx64ad23A8a",
"id": "fr_A31Az5Bs8VIful",
"metadata": {
},
"object": "fee_refund"
@ -632,7 +625,7 @@
"charge": "",
"closed": false,
"currency": "usd",
"customer": "cus_A2bY2OHVFr2450",
"customer": "cus_A319VR7LsNNR72",
"date": 1234567890,
"description": "",
"discount": {
@ -640,11 +633,11 @@
"due_date": 1234567890,
"ending_balance": 0,
"forgiven": false,
"id": "in_19iWLbAjmyEWNT5ftWJqbFns",
"id": "in_19iv7fAuZCWcFwx6zewr2o8W",
"lines": {
"data": [
{
"id": "sub_A2bYQQFBCdLZon",
"id": "sub_A319ljTUL9Ezrc",
"object": "line_item",
"amount": 2000,
"currency": "usd",
@ -654,14 +647,14 @@
"metadata": {
},
"period": {
"start": 1488406382,
"end": 1491084782
"start": 1488501619,
"end": 1491180019
},
"plan": {
"id": "gold",
"object": "plan",
"amount": 2000,
"created": 1485987183,
"created": 1486082419,
"currency": "usd",
"interval": "month",
"interval_count": 1,
@ -675,13 +668,13 @@
"proration": false,
"quantity": 1,
"subscription": null,
"subscription_item": "si_19iWLaBDdAnyIRNMEEZGk4Lk",
"subscription_item": "si_19iv7fBAJmXANnYTsgNrE4yN",
"type": "subscription"
}
],
"total_count": 1,
"object": "list",
"url": "/v1/invoices/in_19iWLbAjmyEWNT5ftWJqbFns/lines"
"url": "/v1/invoices/in_19iv7fAuZCWcFwx6zewr2o8W/lines"
},
"livemode": false,
"metadata": {
@ -706,19 +699,19 @@
"invoice_item": {
"amount": 1000,
"currency": "usd",
"customer": "cus_A2bY2OHVFr2450",
"customer": "cus_A319VR7LsNNR72",
"date": 1234567890,
"description": "My First Invoice Item (created for API docs)",
"discountable": true,
"id": "ii_19iWLbAjmyEWNT5fhok4q5oE",
"id": "ii_19iv7fAuZCWcFwx6iDIywp8Z",
"invoice": "",
"livemode": false,
"metadata": {
},
"object": "invoiceitem",
"period": {
"start": 1485987183,
"end": 1485987183
"start": 1486082419,
"end": 1486082419
},
"plan": {
},
@ -732,14 +725,14 @@
"currency": "usd",
"description": "My First Invoice Item (created for API docs)",
"discountable": true,
"id": "ii_19iWLbAjmyEWNT5fhok4q5oE",
"id": "ii_19iv7fAuZCWcFwx6iDIywp8Z",
"livemode": false,
"metadata": {
},
"object": "line_item",
"period": {
"start": 1485987183,
"end": 1485987183
"start": 1486082419,
"end": 1486082419
},
"plan": {
},
@ -764,18 +757,18 @@
"date": 1234567890,
"delay_reason": "",
"description": "Transfer to test@example.com",
"destination": "ba_19iWLcAjmyEWNT5f0JgFVcl5",
"destination": "ba_19iv7gAuZCWcFwx6mz7Ernfi",
"destination_payment": "",
"failure_code": "",
"failure_message": "",
"id": "tr_19iWLcAjmyEWNT5fin4rxtuH",
"id": "tr_19iv7gAuZCWcFwx61wI4Vzlv",
"legacy_date": 1234567890,
"livemode": false,
"metadata": {
},
"method": "standard",
"object": "transfer",
"recipient": "rp_19iWLcAjmyEWNT5fLlxiIDyW",
"recipient": "rp_19iv7gAuZCWcFwx6mdzt12er",
"reversals": {
"object": "list",
"data": [
@ -783,7 +776,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/transfers/tr_19iWLcAjmyEWNT5fin4rxtuH/reversals"
"url": "/v1/transfers/tr_19iv7gAuZCWcFwx61wI4Vzlv/reversals"
},
"reversed": false,
"source_transaction": "",
@ -808,14 +801,14 @@
"external_sku_ids": [
],
"id": "or_19iWLfAjmyEWNT5f405ZA52r",
"id": "or_19iv7hAuZCWcFwx6yOofIoip",
"items": [
{
"object": "order_item",
"amount": 1500,
"currency": "usd",
"description": "T-shirt",
"parent": "sk_19iWLfAjmyEWNT5fbJbJAYEZ",
"parent": "sk_19iv7hAuZCWcFwx6mjM8OomB",
"quantity": null,
"type": "sku"
}
@ -831,7 +824,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/order_returns?order=or_19iWLfAjmyEWNT5f405ZA52r"
"url": "/v1/order_returns?order=or_19iv7hAuZCWcFwx6yOofIoip"
},
"selected_shipping_method": "",
"shipping": {
@ -861,22 +854,22 @@
"amount": 1500,
"created": 1234567890,
"currency": "usd",
"id": "orret_19iWLfAjmyEWNT5fIWcCvTWa",
"id": "orret_19iv7iAuZCWcFwx6Z4GoyCht",
"items": [
{
"object": "order_item",
"amount": 1500,
"currency": "usd",
"description": "T-shirt",
"parent": "sk_19iWLfAjmyEWNT5fbJbJAYEZ",
"parent": "sk_19iv7hAuZCWcFwx6mjM8OomB",
"quantity": null,
"type": "sku"
}
],
"livemode": false,
"object": "order_return",
"order": "or_19iWLfAjmyEWNT5fMOeUzlbE",
"refund": "re_19iWLfAjmyEWNT5fAhjk4Wa6"
"order": "or_19iv7iAuZCWcFwx6VYrboSLH",
"refund": "re_19iv7iAuZCWcFwx6rxQySnTD"
},
"payment_bank_account": {
"account_holder_name": "Jane Austen",
@ -892,8 +885,8 @@
"currency": "usd",
"customer": "",
"customer_reference": "",
"fingerprint": "fB7ehthnhvdT83AO",
"id": "ba_19iWLcAjmyEWNT5fx5IXF5C7",
"fingerprint": "8yXS6VWD4NBrVfq4",
"id": "ba_19iv7gAuZCWcFwx6IYsLdLWX",
"last4": "6789",
"metadata": {
},
@ -926,7 +919,7 @@
"fingerprint": "",
"funding": "",
"google_reference": "",
"id": "tok_19iWLcAjmyEWNT5fVkGuIuWo",
"id": "tok_19iv7fAuZCWcFwx6t7c1Brjm",
"iin": "",
"issuer": "",
"last4": "",
@ -954,15 +947,15 @@
"trial_period_days": 0
},
"platform_earning": {
"account": "acct_19iWLDAjmyEWNT5f",
"account": "acct_19iv7VAuZCWcFwx6",
"amount": 100,
"amount_refunded": 0,
"application": "ca_A2bYxp6hFIh9393COdJnxAu2ug0kTpDO",
"balance_transaction": "txn_19iWLSAjmyEWNT5fyyQFYAhF",
"charge": "ch_19iWLSAjmyEWNT5fpPrjyMyO",
"application": "ca_A31APLhu7PsdTiS3jGKUwkgWbq9FTo1j",
"balance_transaction": "txn_19iv7cAuZCWcFwx6GAaWDtqL",
"charge": "ch_19iv7cAuZCWcFwx6v5Me3pHJ",
"created": 1234567890,
"currency": "usd",
"id": "fee_A2bYLQ7I4mX4yy",
"id": "fee_19iv7gAuZCWcFwx64ad23A8a",
"livemode": false,
"object": "application_fee",
"originating_transaction": "",
@ -974,7 +967,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/application_fees/fee_A2bYLQ7I4mX4yy/refunds"
"url": "/v1/application_fees/fee_19iv7gAuZCWcFwx64ad23A8a/refunds"
}
},
"product": {
@ -990,7 +983,7 @@
],
"description": "Comfortable gray cotton t-shirts",
"donation": false,
"id": "prod_A2bYKGfMSywDAf",
"id": "prod_A31AbazvQIwW7f",
"images": [
],
@ -1010,7 +1003,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/skus?product=prod_A2bYKGfMSywDAf\u0026active=true"
"url": "/v1/skus?product=prod_A31AbazvQIwW7f\u0026active=true"
},
"tweetable_url": "",
"updated": 1234567890,
@ -1036,7 +1029,7 @@
"fingerprint": "",
"funding": "",
"google_reference": "",
"id": "tok_19iWLcAjmyEWNT5fVkGuIuWo",
"id": "tok_19iv7fAuZCWcFwx6t7c1Brjm",
"iin": "",
"issuer": "",
"last4": "",
@ -1052,13 +1045,13 @@
"refund": {
"amount": 100,
"balance_transaction": "",
"charge": "ch_19iWLSAjmyEWNT5fpPrjyMyO",
"charge": "ch_19iv7cAuZCWcFwx6v5Me3pHJ",
"created": 1234567890,
"currency": "usd",
"description": "",
"fee_balance_transactions": {
},
"id": "re_19iWLTAjmyEWNT5fQsoEZrHw",
"id": "re_19iv7dAuZCWcFwx6wEF66FBk",
"metadata": {
},
"object": "refund",
@ -1075,7 +1068,7 @@
},
"created": 1234567890,
"currency": "usd",
"id": "sku_A2bYIfAjkg9U02",
"id": "sku_A31AY9ZYHSjFsm",
"image": "",
"inventory": {
"quantity": 50,
@ -1089,7 +1082,7 @@
"package_dimensions": {
},
"price": 1500,
"product": "prod_A2bYKGfMSywDAf",
"product": "prod_A31AbazvQIwW7f",
"updated": 1234567890
},
"source": {
@ -1101,7 +1094,7 @@
"currency": "",
"customer": "",
"flow": "",
"id": "card_19iWLPAjmyEWNT5fu8eGG69r",
"id": "card_19iv7cAuZCWcFwx6OD2d1s1g",
"livemode": false,
"metadata": {
},
@ -1126,24 +1119,24 @@
"created": 1234567890,
"current_period_end": 1234567890,
"current_period_start": 1234567890,
"customer": "cus_A2bYdhsHUg8Adj",
"customer": "cus_A319bczRJHoN5e",
"days_until_due": 0,
"discount": {
},
"ended_at": 1234567890,
"id": "sub_A2bYQQFBCdLZon",
"id": "sub_A319ljTUL9Ezrc",
"items": {
"object": "list",
"data": [
{
"id": "si_19iWLaBDdAnyIRNMEEZGk4Lk",
"id": "si_19iv7fBAJmXANnYTsgNrE4yN",
"object": "subscription_item",
"created": 1485987183,
"created": 1486082419,
"plan": {
"id": "gold",
"object": "plan",
"amount": 2000,
"created": 1485987182,
"created": 1486082419,
"currency": "usd",
"interval": "month",
"interval_count": 1,
@ -1159,7 +1152,7 @@
],
"has_more": false,
"total_count": 1,
"url": "/v1/subscription_items?subscription=sub_A2bYQQFBCdLZon"
"url": "/v1/subscription_items?subscription=sub_A319ljTUL9Ezrc"
},
"livemode": false,
"max_occurrences": 0,
@ -1170,7 +1163,7 @@
"id": "gold",
"object": "plan",
"amount": 2000,
"created": 1485987182,
"created": 1486082419,
"currency": "usd",
"interval": "month",
"interval_count": 1,
@ -1190,14 +1183,14 @@
"trial_start": 1234567890
},
"subscription_item": {
"created": 1485987183,
"id": "si_19iWLbBDdAnyIRNMJVwe5AUE",
"created": 1486082420,
"id": "si_19iv7fBAJmXANnYTMZkXL9uf",
"object": "subscription_item",
"plan": {
"id": "gold",
"object": "plan",
"amount": 2000,
"created": 1485987182,
"created": 1486082419,
"currency": "usd",
"interval": "month",
"interval_count": 1,
@ -1214,7 +1207,7 @@
"amount": 1500,
"authenticated": false,
"card": {
"id": "card_19iWLPAjmyEWNT5fu8eGG69r",
"id": "card_19iv7fAuZCWcFwx6h51OmVPb",
"object": "card",
"address_city": null,
"address_country": null,
@ -1240,10 +1233,10 @@
},
"created": 1234567890,
"currency": "usd",
"id": "tdsrc_A2bYC6fwGZJ7d7",
"id": "tdsrc_A31AeeS6r5NHTW",
"livemode": false,
"object": "three_d_secure",
"redirect_url": "http://127.0.0.1:6080/3d_secure/authenticate/tdsrc_A2bYC6fwGZJ7d7",
"redirect_url": "http://127.0.0.1:6080/3d_secure/authenticate/tdsrc_A31AeeS6r5NHTW",
"status": "redirect_pending"
},
"token": {
@ -1254,7 +1247,7 @@
"bank_account": {
},
"card": {
"id": "card_19iWLcAjmyEWNT5fUiteaZyU",
"id": "card_19iv7fAuZCWcFwx6h51OmVPb",
"object": "card",
"address_city": null,
"address_country": null,
@ -1281,7 +1274,7 @@
"created": 1234567890,
"description": "",
"email": "",
"id": "tok_19iWLcAjmyEWNT5fVkGuIuWo",
"id": "tok_19iv7fAuZCWcFwx6t7c1Brjm",
"livemode": false,
"object": "token",
"type": "card",
@ -1291,12 +1284,12 @@
"transfer": {
"amount": 1100,
"amount_reversed": 0,
"balance_transaction": "txn_19iWLSAjmyEWNT5fyyQFYAhF",
"balance_transaction": "txn_19iv7cAuZCWcFwx6GAaWDtqL",
"created": 1234567890,
"currency": "usd",
"destination": "ba_19iWLcAjmyEWNT5f0JgFVcl5",
"destination": "ba_19iv7gAuZCWcFwx6mz7Ernfi",
"destination_payment": "",
"id": "tr_19iWLcAjmyEWNT5fin4rxtuH",
"id": "tr_19iv7gAuZCWcFwx61wI4Vzlv",
"livemode": false,
"metadata": {
},
@ -1308,7 +1301,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/transfers/tr_19iWLcAjmyEWNT5fin4rxtuH/reversals"
"url": "/v1/transfers/tr_19iv7gAuZCWcFwx61wI4Vzlv/reversals"
},
"reversed": false,
"transfer_group": ""
@ -1329,7 +1322,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/recipients/rp_19iWLcAjmyEWNT5fLlxiIDyW/cards"
"url": "/v1/recipients/rp_19iv7gAuZCWcFwx6mdzt12er/cards"
},
"country": "",
"created": 1234567890,
@ -1339,7 +1332,7 @@
"dob_month": "",
"dob_year": "",
"email": "test@example.com",
"id": "rp_19iWLcAjmyEWNT5fLlxiIDyW",
"id": "rp_19iv7gAuZCWcFwx6mdzt12er",
"livemode": false,
"metadata": {
},
@ -1356,11 +1349,11 @@
"balance_transaction": "",
"created": 1234567890,
"currency": "usd",
"id": "trr_19iWLdAjmyEWNT5fGex4KWh7",
"id": "trr_19iv7gAuZCWcFwx6denWHlJn",
"metadata": {
},
"object": "transfer_reversal",
"transfer": "tr_19iWLcAjmyEWNT5fin4rxtuH"
"transfer": "tr_19iv7gAuZCWcFwx61wI4Vzlv"
},
"upcoming_invoice": {
"amount_due": 0,
@ -1371,7 +1364,7 @@
"charge": "",
"closed": false,
"currency": "usd",
"customer": "cus_A2bY2OHVFr2450",
"customer": "cus_A319VR7LsNNR72",
"date": 1234567890,
"description": "",
"discount": {
@ -1386,7 +1379,7 @@
],
"has_more": false,
"total_count": 0,
"url": "/v1/invoices/in_19iWLbAjmyEWNT5ftWJqbFns/lines"
"url": "/v1/invoices/in_19iv7fAuZCWcFwx6zewr2o8W/lines"
},
"livemode": false,
"metadata": {

209
spec/fixtures.yaml
View File

@ -15,15 +15,15 @@ account:
default_currency: usd
details_submitted: false
display_name: ''
email: foo+6tr1wkwhs5@example.com
email: foo+cerbmuaoim@example.com
external_accounts:
object: list
data: []
has_more: false
total_count: 0
url: "/v1/accounts/acct_19iWLDAjmyEWNT5f/external_accounts"
url: "/v1/accounts/acct_19iv7VAuZCWcFwx6/external_accounts"
fake_account: false
id: acct_19iWLDAjmyEWNT5f
id: acct_19iv7VAuZCWcFwx6
legal_entity:
additional_owners:
address:
@ -113,10 +113,10 @@ account_with_keys:
default_currency: usd
details_submitted: false
display_name: ''
email: foo+6tr1wkwhs5@example.com
email: foo+cerbmuaoim@example.com
external_accounts: {}
fake_account: false
id: acct_19iWLDAjmyEWNT5f
id: acct_19iv7VAuZCWcFwx6
keys: {}
legal_entity: {}
light: false
@ -141,8 +141,8 @@ account_with_keys:
alipay_account:
created: 1234567890
customer: ''
fingerprint: UyfN2VnPBRhl8Uc1
id: aliacc_19iWLcAjmyEWNT5fIaupbq3w
fingerprint: GZkE72X71rg717Fi
id: aliacc_19iv7gAuZCWcFwx64HTDib4u
livemode: false
metadata: {}
object: alipay_account
@ -154,7 +154,7 @@ alipay_account:
apple_pay_domain:
created: 1234567890
domain_name: example.com
id: apwc_19iWLPAjmyEWNT5fuAhdxHXu
id: apwc_19iv7cAuZCWcFwx61x1XyMsU
livemode: true
object: apple_pay_domain
balance:
@ -180,16 +180,11 @@ balance_transaction:
description: ''
fee: 0
fee_details: []
id: txn_19iWLSAjmyEWNT5fyyQFYAhF
id: txn_19iv7cAuZCWcFwx6GAaWDtqL
net: 100
object: balance_transaction
source: ch_19iWLSAjmyEWNT5fpPrjyMyO
sourced_transfers:
object: list
data: []
has_more: false
total_count: 0
url: "/v1/transfers?source_transaction=ch_19iWLSAjmyEWNT5fpPrjyMyO"
source: ch_19iv7cAuZCWcFwx6v5Me3pHJ
sourced_transfers: {}
status: pending
type: charge
bitcoin_receiver:
@ -205,7 +200,7 @@ bitcoin_receiver:
description: Receiver for John Doe
email: test@example.com
filled: false
id: btcrcv_19iWLcAjmyEWNT5fUJoSrfl3
id: btcrcv_19iv7gAuZCWcFwx6IUmMP6gm
inbound_address: test_7i9Fo4b5wXcUAuoVBFrc7nc9HDxD1
livemode: false
metadata: {}
@ -220,9 +215,9 @@ bitcoin_transaction:
bitcoin_amount: 1757908
created: 1234567890
currency: usd
id: btctxn_19iWLcAjmyEWNT5fdOVxwSNn
id: btctxn_19iv7gAuZCWcFwx6t5Z5fyPD
object: bitcoin_transaction
receiver: btcrcv_19iWLcBDdAnyIRNM2oInqd5C
receiver: btcrcv_19iv7gBAJmXANnYTogK4b2o1
charge:
alternate_statement_descriptors: {}
amount: 100
@ -233,7 +228,7 @@ charge:
application_fee: ''
application_fees_refunded: 0
authorization_code: ''
balance_transaction: txn_19iWLSAjmyEWNT5fyyQFYAhF
balance_transaction: txn_19iv7cAuZCWcFwx6GAaWDtqL
captured: true
card: {}
created: 1234567890
@ -246,7 +241,7 @@ charge:
failure_message: ''
fee_balance_transactions: {}
fraud_details: {}
id: ch_19iWLSAjmyEWNT5fpPrjyMyO
id: ch_19iv7cAuZCWcFwx6v5Me3pHJ
invoice: ''
level3: {}
livemode: false
@ -264,11 +259,11 @@ charge:
data: []
has_more: false
total_count: 0
url: "/v1/charges/ch_19iWLSAjmyEWNT5fpPrjyMyO/refunds"
url: "/v1/charges/ch_19iv7cAuZCWcFwx6v5Me3pHJ/refunds"
review: ''
shipping: {}
source:
id: card_19iWLPAjmyEWNT5fu8eGG69r
id: card_19iv7cAuZCWcFwx6OD2d1s1g
object: card
address_city:
address_country:
@ -351,7 +346,7 @@ customer:
description: ''
discount: {}
email: ''
id: cus_A2bY2OHVFr2450
id: cus_A319VR7LsNNR72
livemode: false
metadata: {}
object: customer
@ -361,17 +356,17 @@ customer:
data: []
has_more: false
total_count: 0
url: "/v1/customers/cus_A2bY2OHVFr2450/sources"
url: "/v1/customers/cus_A319VR7LsNNR72/sources"
subscription: {}
subscriptions:
object: list
data: []
has_more: false
total_count: 0
url: "/v1/customers/cus_A2bY2OHVFr2450/subscriptions"
url: "/v1/customers/cus_A319VR7LsNNR72/subscriptions"
trust: {}
customer_source:
id: ba_19iWLcAjmyEWNT5fx5IXF5C7
id: ba_19iv7gAuZCWcFwx6IYsLdLWX
metadata: {}
object: bank_account
discount:
@ -379,7 +374,7 @@ discount:
id: 25OFF
object: coupon
amount_off:
created: 1485987184
created: 1486082420
currency: usd
duration: repeating
duration_in_months: 3
@ -390,7 +385,7 @@ discount:
redeem_by:
times_redeemed: 0
valid: true
customer: cus_A2bY2OHVFr2450
customer: cus_A319VR7LsNNR72
end: 1234567890
object: discount
start: 1234567890
@ -399,7 +394,7 @@ dispute:
amount: 1000
balance_transaction: ''
balance_transactions: []
charge: ch_19iWLSAjmyEWNT5fpPrjyMyO
charge: ch_19iv7cAuZCWcFwx6v5Me3pHJ
created: 1234567890
currency: usd
evidence:
@ -431,11 +426,11 @@ dispute:
uncategorized_file:
uncategorized_text:
evidence_details:
due_by: 1487635199
due_by: 1487807999
has_evidence: false
past_due: false
submission_count: 0
id: dp_19iWLTAjmyEWNT5fbvh8ItBH
id: dp_19iv7dAuZCWcFwx6sZh5WWtK
is_charge_refundable: false
is_protected: false
livemode: false
@ -453,7 +448,7 @@ event:
id: gold
object: plan
amount: 2000
created: 1485987183
created: 1486082419
currency: usd
interval: month
interval_count: 1
@ -462,7 +457,7 @@ event:
name: Gold Special
statement_descriptor:
trial_period_days:
id: evt_19iWLdAjmyEWNT5f6lHK5wuz
id: evt_19iv7gAuZCWcFwx6NGKDgMWm
livemode: false
object: event
pending_webhooks: 0
@ -470,7 +465,7 @@ event:
request: ''
type: plan.created
external_account_source:
account: acct_19iWLDAjmyEWNT5f
account: acct_19iv7VAuZCWcFwx6
address_city: ''
address_line1: ''
address_line2: ''
@ -479,8 +474,8 @@ external_account_source:
country: US
currency: usd
default_for_currency: false
fingerprint: fB7ehthnhvdT83AO
id: ba_19iWLcAjmyEWNT5fx5IXF5C7
fingerprint: 8yXS6VWD4NBrVfq4
id: ba_19iv7gAuZCWcFwx6IYsLdLWX
last4: '6789'
metadata: {}
object: bank_account
@ -489,8 +484,8 @@ fee_refund:
balance_transaction: ''
created: 1234567890
currency: usd
fee: fee_A2bYLQ7I4mX4yy
id: fr_A2bYnoyKK3nTDF
fee: fee_19iv7gAuZCWcFwx64ad23A8a
id: fr_A31Az5Bs8VIful
metadata: {}
object: fee_refund
invoice:
@ -502,17 +497,17 @@ invoice:
charge: ''
closed: false
currency: usd
customer: cus_A2bY2OHVFr2450
customer: cus_A319VR7LsNNR72
date: 1234567890
description: ''
discount: {}
due_date: 1234567890
ending_balance: 0
forgiven: false
id: in_19iWLbAjmyEWNT5ftWJqbFns
id: in_19iv7fAuZCWcFwx6zewr2o8W
lines:
data:
- id: sub_A2bYQQFBCdLZon
- id: sub_A319ljTUL9Ezrc
object: line_item
amount: 2000
currency: usd
@ -521,13 +516,13 @@ invoice:
livemode: true
metadata: {}
period:
start: 1488406382
end: 1491084782
start: 1488501619
end: 1491180019
plan:
id: gold
object: plan
amount: 2000
created: 1485987183
created: 1486082419
currency: usd
interval: month
interval_count: 1
@ -539,11 +534,11 @@ invoice:
proration: false
quantity: 1
subscription:
subscription_item: si_19iWLaBDdAnyIRNMEEZGk4Lk
subscription_item: si_19iv7fBAJmXANnYTsgNrE4yN
type: subscription
total_count: 1
object: list
url: "/v1/invoices/in_19iWLbAjmyEWNT5ftWJqbFns/lines"
url: "/v1/invoices/in_19iv7fAuZCWcFwx6zewr2o8W/lines"
livemode: false
metadata: {}
next_payment_attempt: 1234567890
@ -565,18 +560,18 @@ invoice:
invoice_item:
amount: 1000
currency: usd
customer: cus_A2bY2OHVFr2450
customer: cus_A319VR7LsNNR72
date: 1234567890
description: My First Invoice Item (created for API docs)
discountable: true
id: ii_19iWLbAjmyEWNT5fhok4q5oE
id: ii_19iv7fAuZCWcFwx6iDIywp8Z
invoice: ''
livemode: false
metadata: {}
object: invoiceitem
period:
start: 1485987183
end: 1485987183
start: 1486082419
end: 1486082419
plan: {}
proration: false
quantity: 0
@ -587,13 +582,13 @@ invoice_line_item:
currency: usd
description: My First Invoice Item (created for API docs)
discountable: true
id: ii_19iWLbAjmyEWNT5fhok4q5oE
id: ii_19iv7fAuZCWcFwx6iDIywp8Z
livemode: false
metadata: {}
object: line_item
period:
start: 1485987183
end: 1485987183
start: 1486082419
end: 1486082419
plan: {}
proration: false
quantity: 0
@ -613,23 +608,23 @@ legacy_transfer:
date: 1234567890
delay_reason: ''
description: Transfer to test@example.com
destination: ba_19iWLcAjmyEWNT5f0JgFVcl5
destination: ba_19iv7gAuZCWcFwx6mz7Ernfi
destination_payment: ''
failure_code: ''
failure_message: ''
id: tr_19iWLcAjmyEWNT5fin4rxtuH
id: tr_19iv7gAuZCWcFwx61wI4Vzlv
legacy_date: 1234567890
livemode: false
metadata: {}
method: standard
object: transfer
recipient: rp_19iWLcAjmyEWNT5fLlxiIDyW
recipient: rp_19iv7gAuZCWcFwx6mdzt12er
reversals:
object: list
data: []
has_more: false
total_count: 0
url: "/v1/transfers/tr_19iWLcAjmyEWNT5fin4rxtuH/reversals"
url: "/v1/transfers/tr_19iv7gAuZCWcFwx61wI4Vzlv/reversals"
reversed: false
source_transaction: ''
source_type: card
@ -650,13 +645,13 @@ order:
email: ''
external_coupon_code: ''
external_sku_ids: []
id: or_19iWLfAjmyEWNT5f405ZA52r
id: or_19iv7hAuZCWcFwx6yOofIoip
items:
- object: order_item
amount: 1500
currency: usd
description: T-shirt
parent: sk_19iWLfAjmyEWNT5fbJbJAYEZ
parent: sk_19iv7hAuZCWcFwx6mjM8OomB
quantity:
type: sku
livemode: false
@ -667,7 +662,7 @@ order:
data: []
has_more: false
total_count: 0
url: "/v1/order_returns?order=or_19iWLfAjmyEWNT5f405ZA52r"
url: "/v1/order_returns?order=or_19iv7hAuZCWcFwx6yOofIoip"
selected_shipping_method: ''
shipping:
address:
@ -691,19 +686,19 @@ order_return:
amount: 1500
created: 1234567890
currency: usd
id: orret_19iWLfAjmyEWNT5fIWcCvTWa
id: orret_19iv7iAuZCWcFwx6Z4GoyCht
items:
- object: order_item
amount: 1500
currency: usd
description: T-shirt
parent: sk_19iWLfAjmyEWNT5fbJbJAYEZ
parent: sk_19iv7hAuZCWcFwx6mjM8OomB
quantity:
type: sku
livemode: false
object: order_return
order: or_19iWLfAjmyEWNT5fMOeUzlbE
refund: re_19iWLfAjmyEWNT5fAhjk4Wa6
order: or_19iv7iAuZCWcFwx6VYrboSLH
refund: re_19iv7iAuZCWcFwx6rxQySnTD
payment_bank_account:
account_holder_name: Jane Austen
account_holder_type: individual
@ -718,8 +713,8 @@ payment_bank_account:
currency: usd
customer: ''
customer_reference: ''
fingerprint: fB7ehthnhvdT83AO
id: ba_19iWLcAjmyEWNT5fx5IXF5C7
fingerprint: 8yXS6VWD4NBrVfq4
id: ba_19iv7gAuZCWcFwx6IYsLdLWX
last4: '6789'
metadata: {}
object: bank_account
@ -749,7 +744,7 @@ payment_card:
fingerprint: ''
funding: ''
google_reference: ''
id: tok_19iWLcAjmyEWNT5fVkGuIuWo
id: tok_19iv7fAuZCWcFwx6t7c1Brjm
iin: ''
issuer: ''
last4: ''
@ -772,15 +767,15 @@ plan:
statement_descriptor: ''
trial_period_days: 0
platform_earning:
account: acct_19iWLDAjmyEWNT5f
account: acct_19iv7VAuZCWcFwx6
amount: 100
amount_refunded: 0
application: ca_A2bYxp6hFIh9393COdJnxAu2ug0kTpDO
balance_transaction: txn_19iWLSAjmyEWNT5fyyQFYAhF
charge: ch_19iWLSAjmyEWNT5fpPrjyMyO
application: ca_A31APLhu7PsdTiS3jGKUwkgWbq9FTo1j
balance_transaction: txn_19iv7cAuZCWcFwx6GAaWDtqL
charge: ch_19iv7cAuZCWcFwx6v5Me3pHJ
created: 1234567890
currency: usd
id: fee_A2bYLQ7I4mX4yy
id: fee_19iv7gAuZCWcFwx64ad23A8a
livemode: false
object: application_fee
originating_transaction: ''
@ -790,7 +785,7 @@ platform_earning:
data: []
has_more: false
total_count: 0
url: "/v1/application_fees/fee_A2bYLQ7I4mX4yy/refunds"
url: "/v1/application_fees/fee_19iv7gAuZCWcFwx64ad23A8a/refunds"
product:
active: true
attributes:
@ -801,7 +796,7 @@ product:
deactivate_on: []
description: Comfortable gray cotton t-shirts
donation: false
id: prod_A2bYKGfMSywDAf
id: prod_A31AbazvQIwW7f
images: []
livemode: false
metadata: {}
@ -815,7 +810,7 @@ product:
data: []
has_more: false
total_count: 0
url: "/v1/skus?product=prod_A2bYKGfMSywDAf&active=true"
url: "/v1/skus?product=prod_A31AbazvQIwW7f&active=true"
tweetable_url: ''
updated: 1234567890
url: ''
@ -839,7 +834,7 @@ recipient_payout_card:
fingerprint: ''
funding: ''
google_reference: ''
id: tok_19iWLcAjmyEWNT5fVkGuIuWo
id: tok_19iv7fAuZCWcFwx6t7c1Brjm
iin: ''
issuer: ''
last4: ''
@ -852,12 +847,12 @@ recipient_payout_card:
refund:
amount: 100
balance_transaction: ''
charge: ch_19iWLSAjmyEWNT5fpPrjyMyO
charge: ch_19iv7cAuZCWcFwx6v5Me3pHJ
created: 1234567890
currency: usd
description: ''
fee_balance_transactions: {}
id: re_19iWLTAjmyEWNT5fQsoEZrHw
id: re_19iv7dAuZCWcFwx6wEF66FBk
metadata: {}
object: refund
reason: ''
@ -871,7 +866,7 @@ sku:
gender: Unisex
created: 1234567890
currency: usd
id: sku_A2bYIfAjkg9U02
id: sku_A31AY9ZYHSjFsm
image: ''
inventory:
quantity: 50
@ -882,7 +877,7 @@ sku:
object: sku
package_dimensions: {}
price: 1500
product: prod_A2bYKGfMSywDAf
product: prod_A31AbazvQIwW7f
updated: 1234567890
source:
amount: 0
@ -892,7 +887,7 @@ source:
currency: ''
customer: ''
flow: ''
id: card_19iWLPAjmyEWNT5fu8eGG69r
id: card_19iv7cAuZCWcFwx6OD2d1s1g
livemode: false
metadata: {}
object: card
@ -912,22 +907,22 @@ subscription:
created: 1234567890
current_period_end: 1234567890
current_period_start: 1234567890
customer: cus_A2bYdhsHUg8Adj
customer: cus_A319bczRJHoN5e
days_until_due: 0
discount: {}
ended_at: 1234567890
id: sub_A2bYQQFBCdLZon
id: sub_A319ljTUL9Ezrc
items:
object: list
data:
- id: si_19iWLaBDdAnyIRNMEEZGk4Lk
- id: si_19iv7fBAJmXANnYTsgNrE4yN
object: subscription_item
created: 1485987183
created: 1486082419
plan:
id: gold
object: plan
amount: 2000
created: 1485987182
created: 1486082419
currency: usd
interval: month
interval_count: 1
@ -939,7 +934,7 @@ subscription:
quantity: 1
has_more: false
total_count: 1
url: "/v1/subscription_items?subscription=sub_A2bYQQFBCdLZon"
url: "/v1/subscription_items?subscription=sub_A319ljTUL9Ezrc"
livemode: false
max_occurrences: 0
metadata: {}
@ -948,7 +943,7 @@ subscription:
id: gold
object: plan
amount: 2000
created: 1485987182
created: 1486082419
currency: usd
interval: month
interval_count: 1
@ -965,14 +960,14 @@ subscription:
trial_end: 1234567890
trial_start: 1234567890
subscription_item:
created: 1485987183
id: si_19iWLbBDdAnyIRNMJVwe5AUE
created: 1486082420
id: si_19iv7fBAJmXANnYTMZkXL9uf
object: subscription_item
plan:
id: gold
object: plan
amount: 2000
created: 1485987182
created: 1486082419
currency: usd
interval: month
interval_count: 1
@ -986,7 +981,7 @@ three_d_secure:
amount: 1500
authenticated: false
card:
id: card_19iWLPAjmyEWNT5fu8eGG69r
id: card_19iv7fAuZCWcFwx6h51OmVPb
object: card
address_city:
address_country:
@ -1010,17 +1005,17 @@ three_d_secure:
tokenization_method:
created: 1234567890
currency: usd
id: tdsrc_A2bYC6fwGZJ7d7
id: tdsrc_A31AeeS6r5NHTW
livemode: false
object: three_d_secure
redirect_url: http://127.0.0.1:6080/3d_secure/authenticate/tdsrc_A2bYC6fwGZJ7d7
redirect_url: http://127.0.0.1:6080/3d_secure/authenticate/tdsrc_A31AeeS6r5NHTW
status: redirect_pending
token:
account_details: {}
alipay_account: {}
bank_account: {}
card:
id: card_19iWLcAjmyEWNT5fUiteaZyU
id: card_19iv7fAuZCWcFwx6h51OmVPb
object: card
address_city:
address_country:
@ -1045,7 +1040,7 @@ token:
created: 1234567890
description: ''
email: ''
id: tok_19iWLcAjmyEWNT5fVkGuIuWo
id: tok_19iv7fAuZCWcFwx6t7c1Brjm
livemode: false
object: token
type: card
@ -1054,12 +1049,12 @@ token:
transfer:
amount: 1100
amount_reversed: 0
balance_transaction: txn_19iWLSAjmyEWNT5fyyQFYAhF
balance_transaction: txn_19iv7cAuZCWcFwx6GAaWDtqL
created: 1234567890
currency: usd
destination: ba_19iWLcAjmyEWNT5f0JgFVcl5
destination: ba_19iv7gAuZCWcFwx6mz7Ernfi
destination_payment: ''
id: tr_19iWLcAjmyEWNT5fin4rxtuH
id: tr_19iv7gAuZCWcFwx61wI4Vzlv
livemode: false
metadata: {}
object: transfer
@ -1068,7 +1063,7 @@ transfer:
data: []
has_more: false
total_count: 0
url: "/v1/transfers/tr_19iWLcAjmyEWNT5fin4rxtuH/reversals"
url: "/v1/transfers/tr_19iv7gAuZCWcFwx61wI4Vzlv/reversals"
reversed: false
transfer_group: ''
transfer_recipient:
@ -1084,7 +1079,7 @@ transfer_recipient:
data: []
has_more: false
total_count: 0
url: "/v1/recipients/rp_19iWLcAjmyEWNT5fLlxiIDyW/cards"
url: "/v1/recipients/rp_19iv7gAuZCWcFwx6mdzt12er/cards"
country: ''
created: 1234567890
default_card: ''
@ -1093,7 +1088,7 @@ transfer_recipient:
dob_month: ''
dob_year: ''
email: test@example.com
id: rp_19iWLcAjmyEWNT5fLlxiIDyW
id: rp_19iv7gAuZCWcFwx6mdzt12er
livemode: false
metadata: {}
migrated_to: ''
@ -1108,10 +1103,10 @@ transfer_reversal:
balance_transaction: ''
created: 1234567890
currency: usd
id: trr_19iWLdAjmyEWNT5fGex4KWh7
id: trr_19iv7gAuZCWcFwx6denWHlJn
metadata: {}
object: transfer_reversal
transfer: tr_19iWLcAjmyEWNT5fin4rxtuH
transfer: tr_19iv7gAuZCWcFwx61wI4Vzlv
upcoming_invoice:
amount_due: 0
application_fee: 0
@ -1121,7 +1116,7 @@ upcoming_invoice:
charge: ''
closed: false
currency: usd
customer: cus_A2bY2OHVFr2450
customer: cus_A319VR7LsNNR72
date: 1234567890
description: ''
discount: {}
@ -1133,7 +1128,7 @@ upcoming_invoice:
data: []
has_more: false
total_count: 0
url: "/v1/invoices/in_19iWLbAjmyEWNT5ftWJqbFns/lines"
url: "/v1/invoices/in_19iv7fAuZCWcFwx6zewr2o8W/lines"
livemode: false
metadata: {}
next_payment_attempt: 1234567890

389
spec/spec.json
View File

@ -833,39 +833,6 @@
"string"
]
},
"sourced_transfers": {
"properties": {
"has_more": {
"type": [
"boolean"
]
},
"data": {
"items": {
"$ref": "#/definitions/legacy_transfer"
},
"type": [
"array"
]
},
"object": {
"enum": [
"list"
]
},
"url": {
"enum": [
"/v1/transfers"
],
"type": [
"string"
]
}
},
"type": [
"object"
]
},
"status": {
"description": "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.",
"type": [
@ -5351,7 +5318,7 @@
]
},
"type": {
"description": "The `type` of the source to create.",
"description": "The `type` of the source. The `type` is a payment method, one of `card`, `three_d_secure`, `giropay`, `sepa_debit`, `ideal`, `sofort`, or `bancontact`.",
"type": [
"string"
]
@ -7032,7 +6999,7 @@
},
"host": "api.stripe.com",
"info": {
"version": "2016-10-19",
"version": "2017-01-27",
"title": "Stripe API",
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
@ -11094,7 +11061,34 @@
"description": "\u003Cp\u003EReturns a list of your coupons.\u003C/p\u003E",
"operationId": "AllCoupons",
"parameters": [
{
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
"in": "query",
"name": "starting_after",
"required": false,
"type": "string"
},
{
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
"in": "query",
"name": "ending_before",
"required": false,
"type": "string"
},
{
"description": "A filter on the list based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:",
"in": "query",
"name": "created",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
@ -11145,7 +11139,82 @@
"description": "\u003Cp\u003EYou can create coupons easily via the \u003Ca href=\"https://dashboard.stripe.com/coupons\"\u003Ecoupon management\u003C/a\u003E page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.\u003C/p\u003E\n\n\u003Cp\u003EA coupon has either a \u003Ccode\u003Epercent_off\u003C/code\u003E or an \u003Ccode\u003Eamount_off\u003C/code\u003E and \u003Ccode\u003Ecurrency\u003C/code\u003E. If you set an \u003Ccode\u003Eamount_off\u003C/code\u003E, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of \u003Ccurrency\u003E100\u003C/currency\u003E will have a final total of \u003Ccurrency\u003E0\u003C/currency\u003E if a coupon with an \u003Ccode\u003Eamount_off\u003C/code\u003E of \u003Camount\u003E200\u003C/amount\u003E is applied to it and an invoice with a subtotal of \u003Ccurrency\u003E300\u003C/currency\u003E will have a final total of \u003Ccurrency\u003E100\u003C/currency\u003E if a coupon with an \u003Ccode\u003Eamount_off\u003C/code\u003E of \u003Camount\u003E200\u003C/amount\u003E is applied to it.\u003C/p\u003E",
"operationId": "CreateCoupon",
"parameters": [
{
"description": "Body parameters for the request.",
"in": "body",
"name": "payload",
"required": true,
"schema": {
"properties": {
"id": {
"description": "Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g. *FALL25OFF*). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.",
"type": [
"string"
],
"title": "id"
},
"percent_off": {
"description": "A positive integer between 1 and 100 that represents the discount the coupon will apply (required if `amount_off` is not passed)",
"type": [
"integer"
],
"title": "percent_off"
},
"amount_off": {
"description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed)",
"type": [
"integer"
],
"title": "amount_off"
},
"currency": {
"description": "Currency of the `amount_off` parameter (required if `amount_off` is passed)",
"type": [
"string"
],
"title": "currency"
},
"duration": {
"description": "Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`.",
"type": [
"string"
],
"title": "duration"
},
"max_redemptions": {
"description": "A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.",
"type": [
"integer"
],
"title": "max_redemptions"
},
"redeem_by": {
"description": "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.",
"type": [
"integer"
],
"title": "redeem_by"
},
"duration_in_months": {
"description": "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.",
"type": [
"integer"
],
"title": "duration_in_months"
},
"metadata": {
"description": "A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format.",
"type": [
"object"
],
"title": "metadata"
}
},
"required": [
"duration"
]
}
}
],
"responses": {
"200": {
@ -11168,7 +11237,13 @@
"description": "\u003Cp\u003EYou can delete coupons via the \u003Ca href=\"http://dashboard:6090/coupons\"\u003Ecoupon management\u003C/a\u003E page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.\u003C/p\u003E",
"operationId": "DeleteCoupon",
"parameters": [
{
"description": "The identifier of the coupon to be deleted.",
"in": "path",
"name": "coupon",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
@ -11189,7 +11264,13 @@
"description": "\u003Cp\u003ERetrieves the coupon with the given ID.\u003C/p\u003E",
"operationId": "RetrieveCoupon",
"parameters": [
{
"description": "The ID of the desired coupon.",
"in": "path",
"name": "coupon",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
@ -11210,7 +11291,30 @@
"description": "\u003Cp\u003EUpdates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.\u003C/p\u003E",
"operationId": "UpdateCoupon",
"parameters": [
{
"description": "The identifier of the coupon to be updated.",
"in": "path",
"name": "coupon",
"required": true,
"type": "string"
},
{
"description": "Body parameters for the request.",
"in": "body",
"name": "payload",
"required": false,
"schema": {
"properties": {
"metadata": {
"description": "A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format.",
"type": [
"object"
],
"title": "metadata"
}
}
}
}
],
"responses": {
"200": {
@ -13218,7 +13322,7 @@
"title": "trial_end"
},
"quantity": {
"description": "The quantity you'd like to apply to the subscription you're updating. For example, if your plan is \u003Ccurrency\u003E10\u003C/currency\u003E/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged \u003Ccurrency\u003E50\u003C/currency\u003E (5 x \u003Ccurrnecy\u003E10\u003C/currency\u003E) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.",
"description": "The quantity you'd like to apply to the subscription you're updating. For example, if your plan is \u003Ccurrency\u003E10\u003C/currency\u003E/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged \u003Ccurrency\u003E50\u003C/currency\u003E (5 x \u003Ccurrency\u003E10\u003C/currency\u003E) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.",
"type": [
"integer"
],
@ -14185,20 +14289,6 @@
"integer"
],
"title": "days_until_due"
},
"currency": {
"description": "3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).",
"type": [
"string"
],
"title": "currency"
},
"items": {
"description": "",
"type": [
"array"
],
"title": "items"
}
},
"required": [
@ -15258,7 +15348,34 @@
"description": "\u003Cp\u003EReturns a list of your plans.\u003C/p\u003E",
"operationId": "AllPlans",
"parameters": [
{
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
"in": "query",
"name": "starting_after",
"required": false,
"type": "string"
},
{
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
"in": "query",
"name": "ending_before",
"required": false,
"type": "string"
},
{
"description": "A filter on the list based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:",
"in": "query",
"name": "created",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
@ -15309,7 +15426,86 @@
"description": "\u003Cp\u003EYou can create plans easily via the \u003Ca href=\"https://dashboard.stripe.com/plans\"\u003Eplan management\u003C/a\u003E page of the Stripe dashboard. Plan creation is also accessible via the API if you need to create plans on the fly.\u003C/p\u003E",
"operationId": "CreatePlan",
"parameters": [
{
"description": "Body parameters for the request.",
"in": "body",
"name": "payload",
"required": true,
"schema": {
"properties": {
"id": {
"description": "Unique string of your choice that will be used to identify this plan when subscribing a customer. This could be an identifier like \"gold\" or a primary key from your own database.",
"type": [
"string"
],
"title": "id"
},
"amount": {
"description": "A positive integer in **%s** (or 0 for a free plan) representing how much to charge (on a recurring basis).",
"type": [
"integer"
],
"title": "amount"
},
"currency": {
"description": "3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).",
"type": [
"string"
],
"title": "currency"
},
"name": {
"description": "Name of the plan, to be displayed on invoices and in the web interface.",
"type": [
"string"
],
"title": "name"
},
"interval": {
"description": "Specifies billing frequency. Either day, week, month or year.",
"type": [
"string"
],
"title": "interval"
},
"metadata": {
"description": "A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.",
"type": [
"object"
],
"title": "metadata"
},
"interval_count": {
"description": "The number of intervals between each subscription billing. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).",
"type": [
"integer"
],
"title": "interval_count"
},
"trial_period_days": {
"description": "Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won't be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she'll never be billed at all.",
"type": [
"integer"
],
"title": "trial_period_days"
},
"statement_descriptor": {
"description": "An arbitrary string to be displayed on your customer's credit card statement. This may be up to **22 characters**. As an example, if your website is `RunClub` and the item you're charging for is your Silver Plan, you may want to specify a `statement_descriptor` of `RunClub Silver Plan`. The statement description may not include `\u003C\u003E\"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all.",
"type": [
"string"
],
"title": "statement_descriptor"
}
},
"required": [
"id",
"amount",
"currency",
"name",
"interval"
]
}
}
],
"responses": {
"200": {
@ -15332,7 +15528,13 @@
"description": "\u003Cp\u003EYou can delete plans via the \u003Ca href=\"http://dashboard:6090/plans\"\u003Eplan management\u003C/a\u003E page of the Stripe dashboard. However, deleting a plan does not affect any current subscribers to the plan; it merely means that new subscribers can’t be added to that plan. You can also delete plans via the API.\u003C/p\u003E",
"operationId": "DeletePlan",
"parameters": [
{
"description": "The identifier of the plan to be deleted.",
"in": "path",
"name": "plan",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
@ -15353,7 +15555,13 @@
"description": "\u003Cp\u003ERetrieves the plan with the given ID.\u003C/p\u003E",
"operationId": "RetrievePlan",
"parameters": [
{
"description": "The ID of the desired plan.",
"in": "path",
"name": "plan",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
@ -15374,7 +15582,51 @@
"description": "\u003Cp\u003EUpdates the name of a plan. Other plan details (price, interval, etc.) are, by design, not editable.\u003C/p\u003E",
"operationId": "UpdatePlan",
"parameters": [
{
"description": "The identifier of the plan to be updated.",
"in": "path",
"name": "plan",
"required": true,
"type": "string"
},
{
"description": "Body parameters for the request.",
"in": "body",
"name": "payload",
"required": false,
"schema": {
"properties": {
"name": {
"description": "Name of the plan, to be displayed on invoices and in the web interface.",
"type": [
"string"
],
"title": "name"
},
"statement_descriptor": {
"description": "An arbitrary string to be displayed on your customer's credit card statement. This may be up to **22 characters**. As an example, if your website is `RunClub` and the item you're charging for is your Silver Plan, you may want to specify a `statement_descriptor` of `RunClub Silver Plan`. The statement description may not include `\u003C\u003E\"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all.",
"type": [
"string"
],
"title": "statement_descriptor"
},
"metadata": {
"description": "A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.",
"type": [
"object"
],
"title": "metadata"
},
"trial_period_days": {
"description": "Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won't be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she'll never be billed at all.",
"type": [
"integer"
],
"title": "trial_period_days"
}
}
}
}
],
"responses": {
"200": {
@ -17232,7 +17484,7 @@
},
"/v1/sources/{source}": {
"get": {
"description": "\u003Cp\u003ERetrieve an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.\u003C/p\u003E",
"description": "\u003Cp\u003ERetrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.\u003C/p\u003E",
"operationId": "RetrieveSource",
"parameters": [
{
@ -17266,16 +17518,9 @@
}
},
"post": {
"description": "\u003Cp\u003EUpdates a Source.\u003C/p\u003E",
"description": "\u003Cp\u003EUpdates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\u003C/p\u003E\n\n\u003Cp\u003EThis request accepts only the \u003Ccode\u003Emetadata\u003C/code\u003E and \u003Ccode\u003Eowner\u003C/code\u003E as arguments.\u003C/p\u003E",
"operationId": "SourceUpdate",
"parameters": [
{
"description": "",
"in": "path",
"name": "source",
"required": true,
"type": "string"
},
{
"description": "Body parameters for the request.",
"in": "body",
@ -17284,14 +17529,14 @@
"schema": {
"properties": {
"metadata": {
"description": "",
"description": "A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about the source in a structured format.",
"type": [
"object"
],
"title": "metadata"
},
"owner": {
"description": "",
"description": "Information about the owner of the payment instrument that may be used or required by particular source types.",
"type": [
"object"
],
@ -18022,7 +18267,7 @@
"title": "trial_end"
},
"quantity": {
"description": "The quantity you'd like to apply to the subscription you're updating. For example, if your plan is \u003Ccurrency\u003E10\u003C/currency\u003E/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged \u003Ccurrency\u003E50\u003C/currency\u003E (5 x \u003Ccurrnecy\u003E10\u003C/currency\u003E) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.",
"description": "The quantity you'd like to apply to the subscription you're updating. For example, if your plan is \u003Ccurrency\u003E10\u003C/currency\u003E/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged \u003Ccurrency\u003E50\u003C/currency\u003E (5 x \u003Ccurrency\u003E10\u003C/currency\u003E) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.",
"type": [
"integer"
],

371
spec/spec.yaml
View File

@ -624,26 +624,6 @@ definitions:
description: The Stripe object this transaction is related to.
type:
- string
sourced_transfers:
properties:
has_more:
type:
- boolean
data:
items:
"$ref": "#/definitions/legacy_transfer"
type:
- array
object:
enum:
- list
url:
enum:
- "/v1/transfers"
type:
- string
type:
- object
status:
description: If the transaction's net funds are available in the Stripe balance
yet. Either `available` or `pending`.
@ -4069,7 +4049,9 @@ definitions:
type:
- string
type:
description: The `type` of the source to create.
description: The `type` of the source. The `type` is a payment method, one
of `card`, `three_d_secure`, `giropay`, `sepa_debit`, `ideal`, `sofort`,
or `bancontact`.
type:
- string
usage:
@ -5353,7 +5335,7 @@ definitions:
- object
host: api.stripe.com
info:
version: '2016-10-19'
version: '2017-01-27'
title: Stripe API
description: The Stripe REST API. Please see https://stripe.com/docs/api for more
details.
@ -8446,7 +8428,38 @@ paths:
get:
description: "<p>Returns a list of your coupons.</p>"
operationId: AllCoupons
parameters: []
parameters:
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100 items.
in: query
name: limit
required: false
type: integer
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
type: string
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
type: string
- description: 'A filter on the list based on the object `created` field. The
value can be a string with an integer Unix timestamp, or it can be a dictionary
with the following options:'
in: query
name: created
required: false
type: string
responses:
'200':
description: Successful response.
@ -8480,7 +8493,76 @@ paths:
<p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.</p>
operationId: CreateCoupon
parameters: []
parameters:
- description: Body parameters for the request.
in: body
name: payload
required: true
schema:
properties:
id:
description: Unique string of your choice that will be used to identify
this coupon when applying it to a customer. This is often a specific
code you'll give to your customer to use when signing up (e.g. *FALL25OFF*).
If you don't want to specify a particular code, you can leave the
ID blank and we'll generate a random code for you.
type:
- string
title: id
percent_off:
description: A positive integer between 1 and 100 that represents the
discount the coupon will apply (required if `amount_off` is not passed)
type:
- integer
title: percent_off
amount_off:
description: A positive integer representing the amount to subtract
from an invoice total (required if `percent_off` is not passed)
type:
- integer
title: amount_off
currency:
description: Currency of the `amount_off` parameter (required if `amount_off`
is passed)
type:
- string
title: currency
duration:
description: Specifies how long the discount will be in effect. Can
be `forever`, `once`, or `repeating`.
type:
- string
title: duration
max_redemptions:
description: A positive integer specifying the number of times the coupon
can be redeemed before it's no longer valid. For example, you might
have a 50% off coupon that the first 20 readers of your blog can use.
type:
- integer
title: max_redemptions
redeem_by:
description: Unix timestamp specifying the last time at which the coupon
can be redeemed. After the redeem_by date, the coupon can no longer
be applied to new customers.
type:
- integer
title: redeem_by
duration_in_months:
description: Required only if `duration` is `repeating`, in which case
it must be a positive integer that specifies the number of months
the discount will be in effect.
type:
- integer
title: duration_in_months
metadata:
description: A set of key/value pairs that you can attach to a coupon
object. It can be useful for storing additional information about
the coupon in a structured format.
type:
- object
title: metadata
required:
- duration
responses:
'200':
description: Successful response.
@ -8498,7 +8580,12 @@ paths:
new customers can’t redeem the coupon. You can also delete coupons via the
API.</p>
operationId: DeleteCoupon
parameters: []
parameters:
- description: The identifier of the coupon to be deleted.
in: path
name: coupon
required: true
type: string
responses:
'200':
description: Successful response.
@ -8511,7 +8598,12 @@ paths:
get:
description: "<p>Retrieves the coupon with the given ID.</p>"
operationId: RetrieveCoupon
parameters: []
parameters:
- description: The ID of the desired coupon.
in: path
name: coupon
required: true
type: string
responses:
'200':
description: Successful response.
@ -8525,7 +8617,25 @@ paths:
description: "<p>Updates the metadata of a coupon. Other coupon details (currency,
duration, amount_off) are, by design, not editable.</p>"
operationId: UpdateCoupon
parameters: []
parameters:
- description: The identifier of the coupon to be updated.
in: path
name: coupon
required: true
type: string
- description: Body parameters for the request.
in: body
name: payload
required: false
schema:
properties:
metadata:
description: A set of key/value pairs that you can attach to a coupon
object. It can be useful for storing additional information about
the coupon in a structured format.
type:
- object
title: metadata
responses:
'200':
description: Successful response.
@ -10044,7 +10154,7 @@ paths:
description: The quantity you'd like to apply to the subscription you're
updating. For example, if your plan is <currency>10</currency>/user/month,
and your customer has 5 users, you could pass 5 as the quantity to
have the customer charged <currency>50</currency> (5 x <currnecy>10</currency>)
have the customer charged <currency>50</currency> (5 x <currency>10</currency>)
monthly. If you update a subscription but don't change the plan ID
(e.g. changing only the trial_end), the subscription will inherit
the old subscription's quantity attribute unless you pass a new quantity
@ -10826,16 +10936,6 @@ paths:
type:
- integer
title: days_until_due
currency:
description: 3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
type:
- string
title: currency
items:
description: ''
type:
- array
title: items
required:
- customer
responses:
@ -11698,7 +11798,38 @@ paths:
get:
description: "<p>Returns a list of your plans.</p>"
operationId: AllPlans
parameters: []
parameters:
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100 items.
in: query
name: limit
required: false
type: integer
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
type: string
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
type: string
- description: 'A filter on the list based on the object `created` field. The
value can be a string with an integer Unix timestamp, or it can be a dictionary
with the following options:'
in: query
name: created
required: false
type: string
responses:
'200':
description: Successful response.
@ -11731,7 +11862,85 @@ paths:
management</a> page of the Stripe dashboard. Plan creation is also accessible
via the API if you need to create plans on the fly.</p>
operationId: CreatePlan
parameters: []
parameters:
- description: Body parameters for the request.
in: body
name: payload
required: true
schema:
properties:
id:
description: Unique string of your choice that will be used to identify
this plan when subscribing a customer. This could be an identifier
like "gold" or a primary key from your own database.
type:
- string
title: id
amount:
description: A positive integer in **%s** (or 0 for a free plan) representing
how much to charge (on a recurring basis).
type:
- integer
title: amount
currency:
description: 3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
type:
- string
title: currency
name:
description: Name of the plan, to be displayed on invoices and in the
web interface.
type:
- string
title: name
interval:
description: Specifies billing frequency. Either day, week, month or
year.
type:
- string
title: interval
metadata:
description: A set of key/value pairs that you can attach to a plan
object. It can be useful for storing additional information about
the plan in a structured format.
type:
- object
title: metadata
interval_count:
description: The number of intervals between each subscription billing.
For example, `interval=month` and `interval_count=3` bills every 3
months. Maximum of one year interval allowed (1 year, 12 months, or
52 weeks).
type:
- integer
title: interval_count
trial_period_days:
description: Specifies a trial period in (an integer number of) days.
If you include a trial period, the customer won't be billed for the
first time until the trial period ends. If the customer cancels before
the trial period is over, she'll never be billed at all.
type:
- integer
title: trial_period_days
statement_descriptor:
description: An arbitrary string to be displayed on your customer's
credit card statement. This may be up to **22 characters**. As an
example, if your website is `RunClub` and the item you're charging
for is your Silver Plan, you may want to specify a `statement_descriptor`
of `RunClub Silver Plan`. The statement description may not include
`<>"'` characters, and will appear on your customer's statement in
capital letters. Non-ASCII characters are automatically stripped.
While most banks display this information consistently, some may display
it incorrectly or not at all.
type:
- string
title: statement_descriptor
required:
- id
- amount
- currency
- name
- interval
responses:
'200':
description: Successful response.
@ -11748,7 +11957,12 @@ paths:
not affect any current subscribers to the plan; it merely means that new subscribers
can’t be added to that plan. You can also delete plans via the API.</p>
operationId: DeletePlan
parameters: []
parameters:
- description: The identifier of the plan to be deleted.
in: path
name: plan
required: true
type: string
responses:
'200':
description: Successful response.
@ -11761,7 +11975,12 @@ paths:
get:
description: "<p>Retrieves the plan with the given ID.</p>"
operationId: RetrievePlan
parameters: []
parameters:
- description: The ID of the desired plan.
in: path
name: plan
required: true
type: string
responses:
'200':
description: Successful response.
@ -11775,7 +11994,52 @@ paths:
description: "<p>Updates the name of a plan. Other plan details (price, interval,
etc.) are, by design, not editable.</p>"
operationId: UpdatePlan
parameters: []
parameters:
- description: The identifier of the plan to be updated.
in: path
name: plan
required: true
type: string
- description: Body parameters for the request.
in: body
name: payload
required: false
schema:
properties:
name:
description: Name of the plan, to be displayed on invoices and in the
web interface.
type:
- string
title: name
statement_descriptor:
description: An arbitrary string to be displayed on your customer's
credit card statement. This may be up to **22 characters**. As an
example, if your website is `RunClub` and the item you're charging
for is your Silver Plan, you may want to specify a `statement_descriptor`
of `RunClub Silver Plan`. The statement description may not include
`<>"'` characters, and will appear on your customer's statement in
capital letters. Non-ASCII characters are automatically stripped.
While most banks display this information consistently, some may display
it incorrectly or not at all.
type:
- string
title: statement_descriptor
metadata:
description: A set of key/value pairs that you can attach to a plan
object. It can be useful for storing additional information about
the plan in a structured format.
type:
- object
title: metadata
trial_period_days:
description: Specifies a trial period in (an integer number of) days.
If you include a trial period, the customer won't be billed for the
first time until the trial period ends. If the customer cancels before
the trial period is over, she'll never be billed at all.
type:
- integer
title: trial_period_days
responses:
'200':
description: Successful response.
@ -13182,7 +13446,7 @@ paths:
"$ref": "#/definitions/error"
"/v1/sources/{source}":
get:
description: "<p>Retrieve an existing source object. Supply the unique source
description: "<p>Retrieves an existing source object. Supply the unique source
ID from a source creation request and Stripe will return the corresponding
up-to-date source object information.</p>"
operationId: RetrieveSource
@ -13208,14 +13472,12 @@ paths:
schema:
"$ref": "#/definitions/error"
post:
description: "<p>Updates a Source.</p>"
description: |-
<p>Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
<p>This request accepts only the <code>metadata</code> and <code>owner</code> as arguments.</p>
operationId: SourceUpdate
parameters:
- description: ''
in: path
name: source
required: true
type: string
- description: Body parameters for the request.
in: body
name: payload
@ -13223,12 +13485,15 @@ paths:
schema:
properties:
metadata:
description: ''
description: A set of key/value pairs that you can attach to a source
object. It can be useful for storing additional information about
the source in a structured format.
type:
- object
title: metadata
owner:
description: ''
description: Information about the owner of the payment instrument that
may be used or required by particular source types.
type:
- object
title: owner
@ -13825,7 +14090,7 @@ paths:
description: The quantity you'd like to apply to the subscription you're
updating. For example, if your plan is <currency>10</currency>/user/month,
and your customer has 5 users, you could pass 5 as the quantity to
have the customer charged <currency>50</currency> (5 x <currnecy>10</currency>)
have the customer charged <currency>50</currency> (5 x <currency>10</currency>)
monthly. If you update a subscription but don't change the plan ID
(e.g. changing only the trial_end), the subscription will inherit
the old subscription's quantity attribute unless you pass a new quantity