Update Invoice Payment

PUT 
https://euwest.api.elasticpath.com/v2/subscriptions/invoices/:invoice_uuid/payments/:payment_uuid

External payment methods are payment methods not offered by Elastic Path Subscriptions (such as Elastic Path Payments powered by Stripe or Authorize.net), but they can still be integrated with Subscriptions. You can use the Update Invoice Payment endpoint to manually update a payment against an invoice where an external payment method is handling the payment of your invoices. See External Payments.

Request

Responses

200

Success. Invoice payment has been updated.

400

Bad request. The request failed validation.

404

Not found. The requested entity does not exist.

409

Write conflict. Unable to perform the operation at this time.

500

Internal server error. There was a system failure in the platform.

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://euwest.api.elasticpath.com/v2/subscriptions/invoices/:invoice_uuid/payments/:payment_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"11111111-2222-3333-4444-555555555555\",\n    \"type\": \"subscription_invoice_payment\",\n    \"attributes\": {\n      \"success\": true,\n      \"external_payment_id\": \"33e7ec6b-8b34-4c92-a95b-2e2647922e47\",\n      \"failure_detail\": \"Card Failure\",\n      \"payment_taken_at\": \"2017-01-10T11:41:19.244842Z\"\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

invoice_uuid — pathrequired

payment_uuid — pathrequired

Body

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_invoice_payment",
    "attributes": {
      "success": true,
      "external_payment_id": "33e7ec6b-8b34-4c92-a95b-2e2647922e47",
      "failure_detail": "Card Failure",
      "payment_taken_at": "2017-01-10T11:41:19.244842Z"
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!